Alibaba Cloud SDK for Java (V1.0)

If you do not explicitly provide credentials, the SDK uses a default provider chain to look for credentials in the following order:

1. System Properties: Checks for alibabacloud.accessKeyId and alibabacloud.accessKeyIdSecret.
2. Environment Credentials: Checks for ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables.
3. Credentials File: Looks for a configuration file at ~/.alibabacloud/credentials (or C:\Users\USER_NAME\.alibabacloud\credentials on Windows).
   • You can change the file path using the ALIBABA_CLOUD_CREDENTIALS_FILE environment variable.
   • You can select a specific profile using the ALIBABA_CLOUD_PROFILE environment variable.
4. Instance RAM Role: If ALIBABA_CLOUD_ECS_METADATA is defined, the SDK fetches temporary security credentials from the ECS metadata service.

To use the default chain, simply initialize the client with a region ID:

IAcsClient client = new DefaultAcsClient("your-region-id");

Multiple SDK clients share the same connection pool. You can configure pool parameters such as maxRequestsPerHost, connectionTimeoutMillis, and maxIdleConnections during the initialization phase by using HttpClientConfig. This configuration is applied to the DefaultProfile before creating the DefaultAcsClient.

// Create and initialize a DefaultAcsClient instance
DefaultProfile profile = DefaultProfile.getProfile(
"<your-region-id>",          // The region ID
"<your-access-key-id>",      // The AccessKey ID of the RAM account
"<your-access-key-secret>"); // The AccessKey Secret of the RAM account

// Multiple SDK clients share the same connection pool, set the
// parameters for this pool here such as maxRequestsPerHost, timeout, etc.
HttpClientConfig clientConfig = HttpClientConfig.getDefault();
clientConfig.setMaxRequestsPerHost(6);
clientConfig.setConnectionTimeoutMillis(30000L);
clientConfig.setMaxIdleConnections(20);

profile.setHttpClientConfig(clientConfig);
IAcsClient client = new DefaultAcsClient(profile);

⚠️ Important Notice: Alibaba Cloud SDK for Java (V1.0) has entered a basic security maintenance phase and is no longer recommended for new users.

Why migrate to V2.0?

• Better Performance: Improved architecture and optimized performance.
• Enhanced Security: Modern security practices and credential management.
• Continuous Maintenance: Ongoing updates and bug fixes.
• Rich Features: New features and improved API designs.

Migration Resources

• V2.0 SDK Repository: https://github.com/aliyun/alibabacloud-java-sdk
• V2.0 Documentation: https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk
• V1/V2 Comparison: https://help.aliyun.com/zh/sdk/product-overview/differences-between-v1-and-v2-sdks

To use any Alibaba Cloud product SDK, you must install the aliyun-java-sdk-core library in addition to the specific product SDK (e.g., aliyun-java-sdk-ecs). Add the following dependencies to your pom.xml file.

If your Maven environment is not automatically downloading JAR packages from a central repository, you must also explicitly include the gson dependency to avoid NoClassDefFoundError exceptions.

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>[4.3.2,5.0.0)</version>
</dependency>
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-ecs</artifactId>
    <version>[4.16.0,5.0.0)</version>
</dependency>

<!-- Required if Maven fails to download JARs from central repository to avoid NoClassDefFoundError -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.5</version>
</dependency>

The standard workflow for using the V1.0 SDK involves three main steps:

1. Initialize a DefaultAcsClient instance using a DefaultProfile.
2. Create an API request object and set the required parameters.
3. Execute the request using the client and handle ServerException or ClientException.

Security Note: Do not hardcode credentials in your source code. Use external configurations or environment variables instead.

package com.testprogram;

import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.ecs.model.v20140526.*;

public class Main {
    public static void main(String[] args) {
        // 1. Create and initialize DefaultAcsClient instance.
        DefaultProfile profile = DefaultProfile.getProfile(
            "<your-region-id>",          // Region ID
            "<your-access-key-id>",      // RAM AccessKey ID
            "<your-access-key-secret>"); // RAM AccessKey Secret
        IAcsClient client = new DefaultAcsClient(profile);

        // 2. Create API request and set parameters
        DescribeInstancesRequest request = new DescribeInstancesRequest();
        request.setPageSize(10);

        // 3. Send request and handle response or exceptions
        DescribeInstancesResponse response;
        try {
            response = client.getAcsResponse(request);
            for (DescribeInstancesResponse.Instance instance:response.getInstances()) {
                System.out.println(instance.getPublicIpAddress());
            }
        } catch (ServerException e) {
            e.printStackTrace();
         } catch (ClientException e) {
            e.printStackTrace();
        }
    }
}

For products that support Bearer Token authentication (specifically the CCC product), you can initialize the DefaultAcsClient using a BearerTokenCredentials object alongside a DefaultProfile.

package com.testprogram;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.ccc.model.v20170705.ListPhoneNumbersRequest;
import com.aliyuncs.ccc.model.v20170705.ListPhoneNumbersResponse;

public class Main {
    public static void main(String[] args) {
        // Initialize profile with region ID
        DefaultProfile profile = DefaultProfile.getProfile("<your-region-id>");
        
        // Create BearerTokenCredentials
        BearerTokenCredentials bearerTokenCredential = new BearerTokenCredentials("<your-bearer-token>");
        
        // Initialize client with profile and bearer token
        DefaultAcsClient client = new DefaultAcsClient(profile, bearerTokenCredential);
        
        // Create API request
        ListPhoneNumbersRequest request = new ListPhoneNumbersRequest();
        request.setInstanceId("yourId");
        request.setOutboundOnly(true);
        
        ListPhoneNumbersResponse response;
        try {
            response = client.getAcsResponse(request);
            // Handle response logic
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            e.printStackTrace();
        }
    }
}

You can configure proxy settings for the Aliyun Java SDK using either HttpClientConfig (highest priority) or environment variables.

Using HttpClientConfig

Use HttpClientConfig.getDefault() to create a configuration object, then apply it to your IClientProfile before initializing the DefaultAcsClient.

Using Environment Variables

If no client-side configuration is provided, the SDK respects the following environment variables:

1. HTTP_PROXY or http_proxy
2. HTTPS_PROXY
3. NO_PROXY

Note: Client-side configuration takes precedence over environment variables.

// Client 代理配置
HttpClientConfig clientConfig = HttpClientConfig.getDefault();
// 设置HTTP代理
clientConfig.setHttpProxy("http://127.0.0.1:9898");
// 设置HTTPS代理
clientConfig.setHttpsProxy("http://user:password@127.0.0.1:8989");
// 设置忽略代理地址列表
clientConfig.setNoProxy("127.0.0.1,localhost");

IClientProfile profile = DefaultProfile.getProfile(regionId, accesskeyId, accesskeySecret);
profile.setHttpClientConfig(clientConfig);
DefaultAcsClient client = new DefaultAcsClient(profile);