Baidu Cloud Engine Python SDK

Warnings

• deprecated The SDK officially supports Python 2.7, but Python 2.7 reached End-of-Life in 2020. Running new projects or production environments on Python 2.7 is highly discouraged due to security vulnerabilities and lack of community support. The `future` dependency is also noted to be incompatible with Python 3.13.
  Fix: Migrate to Python 3.3 or higher. Ensure your environment uses a supported Python 3 version.
• gotcha Each Baidu Cloud service (e.g., BOS, VPC, BCC) and region has a specific endpoint. Using an incorrect endpoint will result in connection errors or incorrect service interaction.
  Fix: Always refer to the official Baidu AI Cloud documentation for the correct endpoint URL for your specific service and the region you are operating in (e.g., `bj.bcebos.com` for BOS in Beijing).
• gotcha Access Key ID (AK) and Secret Access Key (SK) provide full programmatic access to your Baidu Cloud resources. Exposing them in source code, committing them to version control, or storing them insecurely can lead to unauthorized access and significant security risks.
  Fix: Store AK/SK securely, preferably using environment variables (as shown in quickstart), a dedicated secrets management service, or IAM roles if running on Baidu Cloud infrastructure. Never hardcode them in your application.

Install

• pip install bce-python-sdk Install latest version

Imports

• BceCredentials

  from baidubce.auth.bce_credentials import BceCredentials

• BceClientConfiguration

  from baidubce.bce_client_configuration import BceClientConfiguration

• BosClient

  from baidubce.services.bos import bos_client

  Example for Object Storage (BOS) client. Replace 'bos' with the specific service you need (e.g., 'vpc', 'iam').

Quickstart

This quickstart demonstrates how to initialize a client for Baidu Object Storage (BOS) using your Access Key (AK), Secret Key (SK), and a service endpoint. It shows the basic steps to configure the client and make a sample API call (listing buckets). Remember to replace 'YOUR_AK' and 'YOUR_SK' with your actual credentials, ideally from environment variables, and choose the correct endpoint for your service and region.

import os
from baidubce.auth.bce_credentials import BceCredentials
from baidubce.bce_client_configuration import BceClientConfiguration
from baidubce.services.bos import bos_client
from baidubce.exception import BceHttpClientError

# Configure your Baidu Cloud credentials and endpoint
# It's highly recommended to use environment variables for AK/SK
ACCESS_KEY_ID = os.environ.get('BCE_ACCESS_KEY_ID', 'YOUR_AK')
SECRET_ACCESS_KEY = os.environ.get('BCE_SECRET_ACCESS_KEY', 'YOUR_SK')
BOS_ENDPOINT = os.environ.get('BCE_BOS_ENDPOINT', 'http://bj.bcebos.com') # Example: Beijing region for BOS

if __name__ == '__main__':
    if ACCESS_KEY_ID == 'YOUR_AK' or SECRET_ACCESS_KEY == 'YOUR_SK':
        print("Please set BCE_ACCESS_KEY_ID and BCE_SECRET_ACCESS_KEY environment variables.")
    else:
        try:
            # Initialize client configuration
            config = BceClientConfiguration(
                credentials=BceCredentials(access_key_id=ACCESS_KEY_ID, secret_access_key=SECRET_ACCESS_KEY),
                endpoint=BOS_ENDPOINT
            )
            # Create a BOS client
            client = bos_client.BosClient(config)
            
            # Example: List buckets (replace with actual service calls)
            response = client.list_buckets()
            print("Successfully connected to BOS. Buckets found:")
            for bucket in response.body.buckets:
                print(f"- {bucket.name}")

        except BceHttpClientError as e:
            print(f"An HTTP error occurred: {e}")
        except Exception as e:
            print(f"An unexpected error occurred: {e}")