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

EipClient/EipGroupClient serves as the PHP client for the Eip/EIPGROUP/EipBp services, providing developers with methods to interact with these PHP client services.

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

                PHP
                
            

                //Report all PHP errors
error_reporting(-1);
define('__EIP_CLIENT_ROOT', dirname(__DIR__));
 //Set EipClient Access Key ID, Secret Access Key and ENDPOINT
$EIP_TEST_CONFIG =
    array(
        'credentials' => array(
            'accessKeyId' => 'your ak',
            'secretAccessKey' => 'your sk',
            'sessionToken' => 'your session token'
        ),
        'endpoint' => 'http://eip.bj.baidubce.com',
        'stsEndpoint' => 'http://sts.bj.baidubce.com',
    );
 //Set the log format and level
$__handler = new \Monolog\Handler\StreamHandler(STDERR, \Monolog\Logger::DEBUG);
$__handler->setFormatter(
    new \Monolog\Formatter\LineFormatter(null, null, false, true)
);
\BaiduBce\Log\LogFactory::setInstance(
    new \BaiduBce\Log\MonoLogFactory(array($__handler))
);
\BaiduBce\Log\LogFactory::setLogLevel(\Psr\Log\LogLevel::DEBUG);
            

Note:

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

If users need to specify their own domain name, they can upload the ENDPOINT parameters, which must be defined with the domain name of the specified region. For example, if the service is located in Beijing, the endpoint will be http://eip.bj.baidubce.com.

If STS authentication is not used, stsEndpoint and sessionToken can be left empty or deleted.

Create EipClient/EipGroupClient/EipBpClient with AK/SK

Users can refer to the following code to create an EipClient to access BOS with AK/SK:

                PHP
                
            

                //Use PHP SDK with a custom configuration file
include 'BaiduBce.phar';
require 'YourConf.php';
use BaiduBce\BceClientConfigOptions;
use BaiduBce\Util\Time;
use BaiduBce\Util\MimeTypes;
use BaiduBce\Http\HttpHeaders;
use BaiduBce\Services\Eip\EipClient;
use BaiduBce\Services\EipGroup\EipGroupClient;
 //Call parameters from configuration file
global $EIP_TEST_CONFIG;
 // Create EipClient
$eipClient = new EipClient($EIP_TEST_CONFIG);
 // Create EipGroupClient
$eipGroupClient = new EipGroupClient($EIP_TEST_CONFIG);
 // Create EipBpClient
 $eipBpClient = new Create EipBpClient($EIP_TEST_CONFIG);
            

Create EipClient/EipGroupClient/EipBpClient with STS

Request STS Token

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.

Create EipClient with STS Token

Upon successful application of the STS, it is possible to configure the STS token in EipClient/EipGroupClient. Users may refer to the following code to create a new EipClient/EipGroupClient:

First, configure the STS endpoint. Below is an example of STS configuration:

                PHP
                
            

                $EIP_TEST_CONFIG =
    array(
        'credentials' => array(
            'accessKeyId' => 'your ak',
            'secretAccessKey' => 'your sk',
        ),
	'stsEndpoint' => 'http://sts.bj.baidubce.com',
    );
            

The sample code of StsClient is as follows:

                PHP
                
            

                //Create StsClient
$client = new StsClient($EIP_TEST_CONFIG);
$request =
    array(
 'acl' => $aclArray, //User-defined acl
 'durationSeconds' => 43200, //STS credential validity period
    );
$response = $client->getSessionToken($request);
$accessKeyID= $response->accessKeyId;
$secretAccessKey= $response->secretAccessKey;
$sessionToken = $response->sessionToken;
            

Note: The acl here refers to the user-defined access control list, and its syntax can be referred to in Access Control.

Enter the retrived accessKeyID/secretAccessKey/sessionToken in the configuration file YourConf.php, and create EipClient.

                PHP
                
            

                $EIP_TEST_CONFIG =
    array(
        'credentials' => array(
            'accessKeyId' => 'your ak',
            'secretAccessKey' => 'your sk',
            'sessionToken' => 'your session token'
        ),
        'endpoint' => 'http://eip.bj.baidubce.com',
    );
 // Create EipClient
    $eipClient = new EipClient($EIP_TEST_CONFIG);
 // Create EipGroupClient
    $eipGroupClient = new EipGroupClient($EIP_TEST_CONFIG);
 // Create EipBpClient
    $eipBpClient = new EipBpClient($EIP_TEST_CONFIG);
            

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.

Configure HTTPS protocol to access EIP/EipGroup/EipBp

EIP supports HTTPS transport protocol. Users can use HTTPS to access the EIP/EipGroup service in the EIP PHP SDK in the following two ways:

Specify HTTPS in the endpoint:

                PHP
                
            

                $EIP_CONFIG =
  array(
      'credentials' => array(
          'ak' => 'your-ak',
          'sk' => 'your-sk',
      ),
      'endpoint' => 'https://eip.bj.baidubce.com',
  );
  $eipClient = new EipClient($EIP_CONFIG);
  $eipGroupClient = new EipGroupClient($EIP_CONFIG);
  $eipBpClient = new EipBpClient($EIP_CONFIG);
            

Set the HTTPS protocol by specifying https in protocol:

Plain Text

1$EIP_CONFIG =
2  array(
3      'credentials' => array(
4          'ak' => 'your-ak',
5          'sk' => 'your-sk',
6      ),
7      'endpoint' => 'eip.bj.baidubce.com',
8      'protocol' => 'https',
9  );
10  $eipClient = new EipClient($EIP_CONFIG);
11  $eipGroupClient = new EipGroupClient($EIP_CONFIG);
12  $eipBpClient = new EipBpClient($EIP_CONFIG);

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

                PHP
                
            

                $EIP_CONFIG =
  array(
      'credentials' => array(
          'ak' => 'your-ak',
          'sk' => 'your-sk',
      ),
      'endpoint' => 'http://eip.bj.baidubce.com',
      'protocol' => 'https',
  );
 $eipClient = new EipClient($EIP_CONFIG); //Accesses EIP via HTTP
 $eipGroupClient = new EipGroupClient($EIP_CONFIG); //Accesses eipgroup via HTTP
 $eipBpClient = new EipBpClient($EIP_CONFIG); //Accesses eipBp via HTTP
            

Access EIP/EipGroup/EipBp via custom domain name (CNAME)

Users can access the EIP service using a custom domain name in the EIP PHP SDK in the following way:

Specify the custom domain name in the endpoint and set the custom field to true to indicate the use of a custom domain name:

                PHP
                
            

                $EIP_CONFIG =
  array(
      'credentials' => array(
          'ak' => 'your-ak',
          'sk' => 'your-sk',
      ),
      'endpoint' => 'http://custom-domain.com',
      'custom' => true,
  );
  $eipClient = new EipClient($EIP_CONFIG);
  $eipGroupClient = new EipGroupClient($EIP_CONFIG);
  $eipBpClient = new EipBpClient($EIP_CONFIG);
            

Configure EipClient/EipGroupClient/EipBpClient

Set custom parameters

PHP SDK sets some default parameters in \BaiduBce\Bce.php. To modify these values, users may create custom parameter configuration functions with reference to this file, and pass them during EipClient construction. Reference code is as follows:

                PHP
                
            

                public function CustomizedConfig() {
        $customizedConfig = array(
            BceClientConfigOptions::PROTOCOL => 'http',
            BceClientConfigOptions::REGION => 'bj',
            BceClientConfigOptions::CONNECTION_TIMEOUT_IN_MILLIS => 120 * 1000,
            BceClientConfigOptions::SOCKET_TIMEOUT_IN_MILLIS => 300 * 1000,
            BceClientConfigOptions::SEND_BUF_SIZE => 5 * 1024 * 1024,
            BceClientConfigOptions::RECV_BUF_SIZE => 5 * 1024 * 1024,
            BceClientConfigOptions::CREDENTIALS => array(
                'ak' => 'your-access-key-id',
                'sk' => 'your-secret-access-key',
            ),
            'endpoint' => 'your-endpoint',
        );
 //Create EipClient with custom configuration
        $customizedEipClient = new EipClient($customizedConfig);
 //Create EipGroupClient with custom configuration
        $customizedEipGroupClient = new EipGroupClient($customizedConfig);
 //Create EipGroupClient with custom configuration
        $customizedEipBpClient = new EipBpClient($customizedConfig);
    }
            

The parameter description is as follows:

Parameters	Description	Default value
PROTOCOL	Protocol	http
REGION	Region	bj
CONNECTION_TIMEOUT_IN_MILLIS	Request timeout duration (unit: millisecond)	50 * 1000
SOCKET_TIMEOUT_IN_MILLIS	Timeout for socket data transmission (unit: ms)	0 (infinite waiting. if a non-zero value is set, file size and network speed shall be evaluated; otherwise, uploading large files may cause timeout.)
SEND_BUF_SIZE	Send buffer size	1024 * 1024
RECV_BUF_SIZE	Receive buffer size	10 1024 1024

Exception handling

Install the SDK Package