Initialization

Updated at：2025-10-16

Confirm Endpoint

Before configuring the endpoint for SDK usage, please refer toAPI Service Domain Name in API Reference to understand endpoint-related concepts. Baidu AI Cloud currently supports multiple regions. Please refer toRegion Selection Guide. Corresponding information:

Access region	Endpoint
Beijing	eip.bj.baidubce.com
Guangzhou	eip.gz.baidubce.com
Suzhou	eip.su.baidubce.com
Hong Kong	eip.hkg.baidubce.com
Wuhan	eip.fwh.baidubce.com
Baoding	eip.bd.baidubce.com

Retrieve access key

To use Baidu AI Cloud EIP, users need a valid AK (Access Key ID) and SK (Secret Access Key) for signature certification. AK/SK are system-assigned strings used to identify users and perform signature certification for EIP. Your AK/SK information can be obtained and understood through the following steps: Register a Baidu AI Cloud account Create AK/SK

Create EipClient/EipGroupClient/EipBpClient/EipTpClient

EipClient/EipGroupClient/EipBpClient/EipTpClient is the Python client for EIP services, enabling developers to interact with EIP services using a variety of provided methods.

Create EipClient/EipGroupClient/EipBpClient/EipTpClient with AK/SK

Before creating EipClient/EipGroupClient, a configuration file must be created for the purpose of configuring EipClient/EipGroupClient/EipBpClient/EipTpClient. In the example below, this file is named eip_sample_conf.py, with the following configuration details:

                Python
                
            

                #!/usr/bin/env python
#coding=utf-8
# Import Python standard logging module
import logging
# Import EIP configuration management module and security authentication module from Python SDK
from baidubce.bce_client_configuration import BceClientConfiguration
from baidubce.auth.bce_credentials import BceCredentials
# Set EipClient Host, Access Key ID, and Secret Access Key
eip_host = "eip.bj.baidubce.com"
access_key_id = "AK"
secret_access_key = "SK"
# Set log file handles and log levels
logger = logging.getLogger('baidubce.http.bce_http_client')
fh = logging.FileHandler("sample.log")
fh.setLevel(logging.DEBUG)
# Set the order, structure and content of log file output
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
logger.setLevel(logging.DEBUG)
logger.addHandler(fh)
# Create BceClientConfiguration instance
config = BceClientConfiguration(credentials=BceCredentials(access_key_id, secret_access_key), endpoint = eip_host)
            

Note: For log files, Logging are available the following levels: DEBUG, INFO, WARNING, ERROR, CRITICAL.

In the code above, access_key_id corresponds to “Access Key ID” in the console. secret_access_key corresponds to “Access Key Secret” in the console. For the method to retrieve them, refer to the Guide - Manage ACCESSKEY.

The method above requires users to specify the EIP server domain name by themselves, which can be assigned to the eip_host variable. If not specified, there is no need to pass the endpoint parameter; the default is the Beijing region http://eip.bj.baidubce.com.

After completing the above configuration, refer to the following code to create an EipClient/EipGroupClient/EipBpClient/EipTpClient.

                Python
                
            

                # Import the EipClient configuration file
import eip_sample_conf
		
# Import Eip-related modules
from baidubce import exception
from baidubce.services import eip
from baidubce.services.eip.eip_client import EipClient
from baidubce.services.eip.eip_group_client import EipGroupClient
from baidubce.services.eip.eip_bp_client import EipBpClient
from baidubce.services.eip.eip_tp_client import EipTpClient
# Create EipClient
eip_client = EipClient(eip_sample_conf.config)
 #Create EipGroupClient
eip_group_client = EipGroupClient(eip_sample_conf.config)
 #Create EipBpClient
eip_bp_client = EipBpClient(eip_sample_conf.config)
 #Create EipTpClient
eip_tp_client = EipTpClient(eip_sample_conf.config)
            

Create EipClient/EipGroupClient/EipBpClient/EipTpClient with STS

EIP allows temporary third-party access authorization using the STS mechanism. STS (Security Token Service) is a temporary authorization service offered by Baidu AI Cloud. With STS, you can issue access credentials with customizable validity periods and permissions to third-party users. These users can then utilize the credentials to directly call Baidu AI Cloud APIs or SDKs to access cloud resources.

To access EIP via STS, users must first request a certification string through the STS client. For instructions on obtaining STS credentials, refer to Baidu AI Cloud STS Usage Guide.

Obtain a temporary token and create a configuration file named "sts_sample_conf.py" for setting up the EipClient/EipGroupClient/EipBpClient/EipTpClient.

                Python
                
            

                import logging
from baidubce.bce_client_configuration import BceClientConfiguration
from baidubce.auth.bce_credentials import BceCredentials
sts_host = "STS_HOST"
access_key_id = "AK"
secret_access_key = "SK"
logger = logging.getLogger('baidubce.services.sts.stsclient')
fh = logging.FileHandler("sample.log")
fh.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
logger.setLevel(logging.DEBUG)
logger.addHandler(fh)
config = BceClientConfiguration(credentials=BceCredentials(access_key_id, secret_access_key), endpoint=sts_host)
            

Note: Currently, when configuring a client with STS, regardless of where the corresponding EIP service endpoint is located, the endpoint must be set to http://sts.bj.baidubce.com.

Create a new StsClient and configure BceClientConfiguration using the obtained temporary token. Create a file "sts_sample.py" to apply for a set of AK, SK and token through StsClient.

                Python
                
            

                import sts_sample_conf
from baidubce.services.sts.sts_client import StsClient
from baidubce.bce_client_configuration import BceClientConfiguration
from baidubce.auth.bce_credentials import BceCredentials
sts_client = StsClient(sts_sample_conf.config)
duration_seconds = 3600
# you can specify limited permissions with ACL
access_dict = {}
access_dict["service"] = "your service words"
access_dict["region"] = "bj"   
access_dict["effect"] = "Allow"
resource = ["*"]
access_dict["resource"] = resource
permission = ["READ"]
access_dict["permission"] = permission
access_control_list = {"accessControlList": [access_dict]}
# Create StsClient
response = sts_client.get_session_token(acl=access_control_list, duration_seconds=duration_seconds)
sts_ak = str(response.access_key_id)
sts_sk = str(response.secret_access_key)
token = response.session_token
eip_host = "EIP_HOST"
# Configure BceClientConfiguration instance
config = BceClientConfiguration(credentials=BceCredentials(sts_ak, sts_sk), endpoint = eip_host, security_token=token)
            

After completing the above configuration, refer to the following code to create an EipClient/EipGroupClient/EipBpClient/EipTpClient.

                Python
                
            

                 import sts_sample
		
# Import EIP-related modules
 from baidubce import exception
 from baidubce.services import eip
 from baidubce.services.eip.eip_client import EipClient
 from baidubce.services.eip.eip_group_client import EipGroupClient
 from baidubce.services.eip.eip_bp_client import EipBpClient
 from baidubce.services.eip.eip_tp_client import EipTpClient
	
# Create EipClient
 eip_client = EipClient(sts_sample.config)
 #Create EipGroupClient
 eip_group_client = EipGroupClient(sts_sample.config)
 #Create EipBpClient
 eip_bp_client = EipBpClient(sts_sample.config)
 #Create EipTpClient
 eip_tp_client = EipTpClient(eip_sample_conf.config)
            

Configure HTTPS protocol to access EIP/EIPGroup/EipBp/EipTp

EIP supports HTTPS transport protocol. You can use HTTPS to access the EIP service in the EIP Python SDK in the following two ways:

Specify HTTPS in the endpoint:

                Python
                
            

                 config = bce_client_configuration.BceClientConfiguration(
    credentials = bce_credentials.BceCredentials(
        access_key_id = 'your-ak',
  	    secret_access_key = 'your-sk'
    ),
    endpoint = 'https://eip.bj.baidubce.com'
 )
 eip_client = eip_client.EipClient(config)
 eip_group_client = eip_group_client.EipGroupClient(config)
 eip_bp_client = eip_bp_client.EipBpClient(config)
 eip_tp_client = eip_tp_client_EipTpClient(config)
            

Set the HTTPS protocol by specifying https in protocol:

                Python
                
            

                config = bce_client_configuration.BceClientConfiguration(
    credentials = bce_credentials.BceCredentials(
        access_key_id = 'your-ak',
	    secret_access_key = 'your-sk'
    ),
    endpoint = 'eip.bj.baidubce.com',
    protocol = baidubce.protocol.HTTPS
)
eip_client = eip_client.EipClient(config)
eip_group_client = eip_group_client.EipGroupClient(config)
eip_bp_client = eip_bp_client.EipBpClient(config)
eip_tp_client = eip_tp_client_EipTpClient(config)
            

Note: If you specify the protocol parameter while specifying the scheme of the endpoint, the endpoint shall prevail.

                Python
                
            

                config = bce_client_configuration.BceClientConfiguration(
    credentials = bce_credentials.BceCredentials(
        access_key_id = 'your-ak',
	    secret_access_key = 'your-sk'
    ),
    endpoint = 'http://bj.bcebos.com',
    protocol = baidubce.protocol.HTTPS
)
# All in HTTP type
eip_client = eip_client.EipClient(config)
eip_group_client = eip_group_client.EipGroupClient(config)
eip_bp_client = eip_bp_client.EipBpClient(config)
eip_tp_client = eip_tp_client_EipTpClient(config)
            

Configure EipClient/EipGroupClient/EipBpClient

Set network parameters

Users can set some network parameters:

                Python
                
            

                # Set request timeout duration
eip_sample_conf.config.connection_timeout_in_mills = TIMEOUT
	    
# Set receive buffer size
eip_sample_conf.config.recv_buf_size(BUF_SIZE)
	
# Set send buffer size
eip_sample_conf.config.send_buf_size(BUF_SIZE)
	
# Set connection retry policy
# Three-time exponential backoff retry
eip_sample_conf.config.retry_policy = BackOffRetryPolicy()
# No retry
eip_sample_conf.config.retry_policy = NoRetryPolicy()
            

Exception handling

Install the SDK Package