Initialization

Updated at：2025-11-11

Confirm Endpoint

Before configuring the endpoint for SDK usage, please refer to the developer guide section on API Service Domain Name to understand Endpoint-related concepts.

Access region	Endpoint
Global	bcc.bj.baidubce.com

Retrieve AK/SK

To access Baidu AI Cloud ET services, you need a valid AK (Access Key ID) and SK (Secret Access Key) for signature authentication. The AK/SK are system-generated credentials used to identify users and perform certified authentication for accessing services. You can obtain and familiarize yourself with your credentials by following these steps:

Create EtClient

The EtClient serves as the client interface for ET services, offering developers a variety of methods to interact with ET services.

Create EtClient with AK/SK

Users can refer to the following code to create a client to access BOS with AK/SK:

                Java
                
            

                public class Sample {
    public static void main(String[] args) {
 String ACCESS_KEY_ID =<your-access-key-id>;                   // User’s Access Key ID
 String SECRET_ACCESS_KEY =<your-secret-access-key>;           // User’s Secret Access Key
        
 // Initialize an EtClient
        EtClientConfiguration config = new EtClientConfiguration();
        config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
        EtClient client = new EtClient(config);
    }
}
            

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.

By default, the above method uses the ET service's default domain name as the service address. To use a custom domain, you can provide an ENDPOINT parameter.

                Java
                
            

                String ACCESS_KEY_ID =<your-access-key-id>;                   // User’s Access Key ID
 String SECRET_ACCESS_KEY =<your-secret-access-key>;           // User’s Secret Access Key
 String ENDPOINT = <domain-name>;                               // User-defined domain name
 EtClientConfiguration config = new EtClientConfiguration();
 config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
 config.setEndpoint(ENDPOINT);
 EtClient client = new EtClient(config);
            

Create EtClient with STS

Request STS Token

ET supports temporary third-party access authorization via the STS mechanism. STS (Security Token Service) is a temporary authorization service provided by Baidu AI Cloud. It enables you to generate short-term credentials with tailored permissions and validity periods for third-party users, allowing them to directly access cloud resources via Baidu AI Cloud APIs or SDKs.

To access ET 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 EtClientwith STS Token

After requesting the STS token, configure it in the EtClient. The following codes demonstrate how to create an EtClient:

                Java
                
            

                public class StsExample {
    private static final String STS_ENDPOINT = "http://sts.bj.baidubce.com";
    private static final String ACCESS_KEY_ID = "your accesskey id";
    private static final String SECRET_ACCESS_KEY = "your secret accesskey";
    public static void main(String[] args) {
        BceCredentials credentials = new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY);
        StsClient client = new StsClient(
                new BceClientConfiguration().withEndpoint(STS_ENDPOINT).withCredentials(credentials)
        );
        GetSessionTokenResponse response = client.getSessionToken(new GetSessionTokenRequest());
        // or simply call:
        // GetSessionTokenResponse response = client.getSessionToken();
        // or you can specify limited permissions with ACL:
        // GetSessionTokenResponse response = client.getSessionToken(new GetSessionTokenRequest().withAcl("blabla"));
        // build DefaultBceSessionCredentials object from response:
        BceCredentials etStsCredentials = new DefaultBceSessionCredentials(
                response.getAccessKeyId(),
                response.getSecretAccessKey(),
                response.getSessionToken());
        System.out.println("==================================");
        System.out.println("GetSessionToken result:");
        System.out.println("    accessKeyId:  " + response.getAccessKeyId());
        System.out.println("    secretAccessKey:  " + response.getSecretAccessKey());
        System.out.println("    securityToken:  " + response.getSessionToken());
        System.out.println("    expiresAt:  " + response.getExpiration().toString());
        System.out.println("==================================");
        // build ET client
        EtClientConfiguration config = new EtClientConfiguration();
        config.setCredentials(etStsCredentials);
        EtClient client = new EtClient(config);
    }
}
            

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

Configure HTTPS access to ET

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

Specify HTTPS in the endpoint:

                Java
                
            

                 String endpoint = "https://bcc.bj.baidubce.com";
 String ak = "ak";
 String sk = "sk";
 EtClientConfiguration config = new EtClientConfiguration();
 config.setCredentials(new DefaultBceCredentials(ak, sk));
 EtClient client = new EtClient(config);
            

Configure HTTPS by calling setProtocol:

                Java
                
            

                String endpoint = "bcc.bj.baidubce.com"; // endpoint without protocol
 String ak = "ak";
 String sk = "sk";
 EtClientConfiguration config = new EtClientConfiguration();
 config.setCredentials(new DefaultBceCredentials(ak, sk));
 config.setEndpoint(ENDPOINT);
 config.setProtocol(Protocol.HTTPS); // Defaults to HTTP if unspecified
 EtClient client = new EtClient(config);
            

Note: If the endpoint already includes a protocol, the one in endpoint takes effect, and the setProtocol() method will be ignored.

                Java
                
            

                 String endpoint = "http://bcc.bj.baidubce.com";
 String ak = "ak";
 String sk = "sk";
 EtClientConfiguration config = new EtClientConfiguration();
 config.setCredentials(new DefaultBceCredentials(ak, sk));
 config.setEndpoint(ENDPOINT);    
 config.setProtocol(Protocol.HTTPS); // Invalid operation if specified in endpoint, applicable to HTTP cases
 EtClient client = new EtClient(config);
            

Configure EtClient

To configure customization options for the EtClient, initialize it with an EtClientConfiguration object. This allows you to specify proxy settings, maximum connections, or other network-related configurations.

Use a proxy

The following code snippet enables the client to access ET service using a proxy:

                Java
                
            

                String ACCESS_KEY_ID =<your-access-key-id>;                   // User’s Access Key ID
 String SECRET_ACCESS_KEY =<your-secret-access-key>;           // User’s Secret Access Key
 String ENDPOINT = <domain-name>;                               // User-defined domain name
 // Create EtClientConfiguration instance
 EtClientConfiguration config = new EtClientConfiguration();
 // Configure proxy to local port 8080
 config.setProxyHost("127.0.0.1");
 config.setProxyPort(8080);
 // Create ET client
 config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
 config.setEndpoint(ENDPOINT);
 EtClient client = new EtClient(config);
            

All client requests will then be routed through the proxy at 127.0.0.1:8080.

For verified proxies, configure credentials:

Plain Text

1// Create EtClientConfiguration instance
2 EtClientConfiguration config = new EtClientConfiguration();
3    
4 // Configure proxy to local port 8080
5 config.setProxyHost("127.0.0.1");
6 config.setProxyPort(8080);
7    
8 // Set username and password
9 config.setProxyUsername(<username>);                             // Username
10 config.setProxyPassword(<password>);                             // Password

Set network parameters

Users may set the basic network parameters with EtClientConfiguration:

                Java
                
                EtClientConfiguration config = new EtClientConfiguration();
    
 // Set maximum number of HTTP connections to 10
config.setMaxConnections(10);
    
 // Set TCP connection timeout to 5,000 milliseconds
config.setConnectionTimeout(5000);
    
 // Set timeout for Socket data transmission to 2,000 milliseconds
config.setSocketTimeout(2000);

Parameter description The following parameters can be configured via EtClientConfiguration:

Parameters	Description
UserAgent	User agent, refers to HTTP’s User-Agent header
Protocol	Connection protocol type
ProxyDomain	Windows domain for NTLM-verified proxy
ProxyHost	Proxy server host address
ProxyPort	Proxy server port
ProxyUsername	Proxy verification username
ProxyPassword	Proxy verification password
ProxyPreemptiveAuthenticationEnabled	Enable user agent verification or not
ProxyWorkstation	NTLM proxy workstation name
LocalAddress	Local address
ConnectionTimeoutInMillis	Timeout for establishing TCP connections (unit: ms)
SocketTimeoutInMillis	Timeout for socket data transmission (unit: ms)
MaxConnections	Maximum allowable HTTP connections
RetryPolicy	Retry policy for connections
SocketBufferSizeInBytes	Buffer size for socket operations

Exception handling

Install the SDK Package