BccClient

Updated at：2025-10-20

BccClient is the client for the BCC service, providing developers with various methods to interact with the BCC service, including instances, disks, images, snapshots, security groups, availability zones, and more.

Create BccClient

Access BCC via AK/SK

Users can refer to the following code to create BccClient:

Plain Text

1public class Sample {
2public static void main(String[] args) {
3 String ACCESS_KEY_ID =<your-access-key-id>;                   // User’s Access Key ID
4 String SECRET_ACCESS_KEY =<your-secret-access-key>;           // User’s Secret Access Key
5
6 // Initialize a BCCClient
7    BccClientConfiguration config = new BccClientConfiguration();
8    config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
9    BccClient client = new BccClient(config);
10    }
11}

In the above code, the variables ACCESS_KEY_ID and SECRET_ACCESS_KEY are assigned to the user by the system, both are strings, used to identify the user and for signature verification to access BCC. ACCESS_KEY_ID corresponds to “Access Key ID” in the console. SECRET_ACCESS_KEY corresponds to “Access Key Secret” in the console. Refer to the Guide - [ Retrieve ACCESSKEY](Reference/Retrieve AK and SK/How to Obtain AKSK.md).

The above method uses the default domain name as the BCC service address. To use a custom domain name, specify the 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
BccClientConfiguration config = new BccClientConfiguration();
config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
config.setEndpoint(ENDPOINT);
BccClient client = new BccClient(config);
            

Note: The ENDPOINT parameter can only be defined with the specified domain name containing the region. If not specified, it defaults to the Beijing region http://bcc.bj.baidubce.com. Baidu AI Cloud currently supports multiple regions. For more information, please refer to [Region Selection Guide](Reference/Region Selection Instructions/Region.md) and Service Domain

Configure HTTPS access to BCC

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

Specify HTTPS in the endpoint:

                Java
                
            

                String endpoint = "http://bcc.bj.baidubce.com";
String ak = "ak";
String sk = "sk";
BccClientConfiguration config = new BccClientConfiguration();
config.setCredentials(new DefaultBceCredentials(ak, sk));
BccClient client = new BccClient(config);
            

Configure HTTPS by calling setProtocol:

                Java
                
            

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

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

                Java
                
            

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

Configure BccClient

If users need to configure specific parameters for BccClient, they can specify the BccClientConfiguration object when creating BccClient. BccClientConfiguration is the configuration class for the BCC service, allowing users to set parameters such as proxies and the maximum number of connections for the client.

Use a proxy

The following code snippet enables the client to access BCC 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 BccClientConfiguration
BccClientConfiguration config = new BccClientConfiguration();
 // Configure proxy to local port 8080
config.setProxyHost("127.0.0.1");
config.setProxyPort(8080);
 // Create BCC client
config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
config.setEndpoint(ENDPOINT);
BccClient client = new BccClient(config);
            

All client operations will then route through the proxy at 127.0.0.1:8080. For verified proxies, configure credentials:

                Java
                
            

                // Create BccClientConfiguration
BccClientConfiguration config = new BccClientConfiguration();
 // Configure proxy to local port 8080
config.setProxyHost("127.0.0.1");
config.setProxyPort(8080);
 // Set username and password
 config.setProxyUsername(<username>);                             // Username
 config.setProxyPassword(<password>);                             // Password
            

Set network parameters

Users may set the basic network parameters with BccClientConfiguration:

                Java
                
            

                BccClientConfiguration config = new BccClientConfiguration();
 // 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 BccClientConfiguration:

Parameters	Description
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
StreamBufferSize	Stream file buffer size

BCC instance

Deployment group