Alibaba Cloud SDK:Use Alibaba Cloud SDKs for Java in an IDE

Go to OpenAPI Explorer. Search for the API operation that you want to use. In this example, the DescribeInstanceTypeFamilies operation of Elastic Compute Service (ECS) is used. Enter DescribeInstanceTypeFamilies in the search box, and click DescribeInstanceTypeFamilies in the search results to go to the API debugging page.

On the Parameters tab in the middle column, specify the parameters based on your business requirements. When you specify the parameters, read the information on the Document tab in the rightmost column. Make sure that you understand the usage notes of the operation and the description of each parameter. Pay attention to billing-related information. In this example, the DescribeInstanceTypeFamilies operation supports two request parameters. You must specify a value such as cn-hangzhou for the RegionId parameter. The Generation parameter is optional. You can set this parameter to ecs-5, which indicates the V-series instance family. You can view the valid values of the parameters on the Document tab.

On the SDK Sample Code tab in the rightmost column, select a programming language and click Download Project to download the complete SDK project to your computer. Then, decompress the package.

Open IntelliJ IDEA, choose File > Open in the top navigation bar, and then select the decompressed project folder. Wait for Maven to automatically install the dependency.

Before you call this operation, you must obtain an AccessKey pair as the access credential. We recommend that you use the AccessKey pair of a Resource Access Management (RAM) user. For more information, see the Create an AccessKey pair for a RAM user section of the "Create an AccessKey pair" topic.

Run the SDK demo code.

In the left-side directory tree, double-click Sample to open it. Click the Run icon in the upper-right corner of the editor to run the code.

View the result. Click anywhere in the Run window in the lower part of the console and press Ctrl+F to search for statusCode. If "statusCode":200 is displayed, the call was successful.

Obtain the SDK.

Go to SDK Center and select the cloud service whose SDK you want to use. In this example, ECS is used. Select V2.0 as the SDK version and Java as the programming language. In the Installation Method section of the Quick Start tab, select Apache Maven.

Import the SDK.

Open the Maven project that you created in IntelliJ IDEA. In the pom.xml file, create the <dependencies></dependencies> tag and copy the code obtained in Step 1 within the tag.

    <dependencies>
        <!--ECS V2.0 SDK -->
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>ecs20140526</artifactId>
            <version>5.1.2</version>
        </dependency>
    </dependencies>

Right-click the project name and choose Maven > Reload project to download the Maven dependency.

Create a Java class.

In the src/main/java directory of the project, right-click the java folder and choose New > Java Class. In this example, the Java class is named Sample.

Initialize the cloud service client.

import com.aliyun.ecs20140526.Client;
import com.aliyun.teaopenapi.models.Config;

public class Sample {
    public static void main(String[] args) throws Exception {
        Config config = new Config()
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        config.endpoint = "ecs-cn-hangzhou.aliyuncs.com";
        Client client = new Client(config);
    }
}

Call the API operation.

Before you call an API operation, you must read the corresponding API documentation.

In the Maven dependency for a cloud service, the cloud service SDK provides a request class and response class for each API operation. A request class defines the parameters and value types. A response class defines the response parameters. This prevents spelling mistakes when you call the operation.

For example, for the describeInstanceTypeFamilies operation, its request class is DescribeInstanceTypeFamiliesRequest and response class is DescribeInstanceTypeFamiliesResponse.

import com.aliyun.ecs20140526.Client;
import com.aliyun.ecs20140526.models.DescribeInstanceTypeFamiliesRequest;
import com.aliyun.ecs20140526.models.DescribeInstanceTypeFamiliesResponse;
import com.aliyun.teaopenapi.models.Config;

public class Sample {
    public static void main(String[] args) throws Exception {
            Config config = new Config()
                    .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                    .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
            config.endpoint = "ecs-cn-hangzhou.aliyuncs.com";
            Client client = new Client(config);
            DescribeInstanceTypeFamiliesRequest describeInstanceTypeFamiliesRequest = new DescribeInstanceTypeFamiliesRequest();
            describeInstanceTypeFamiliesRequest.setRegionId("cn-hangzhou");
            DescribeInstanceTypeFamiliesResponse describeInstanceTypeFamiliesResponse = client.describeInstanceTypeFamilies(describeInstanceTypeFamiliesRequest);
    }
}

Handle exceptions. Alibaba Cloud SDKs handle exceptions in a unified manner.

TeaException: This type of exceptions are caused by business errors. The following three parameters are provided to handle such an exception:

• code: the error code that is returned when the exception occurs.

• message: the error message that is returned when the exception occurs. The message contains the ID of the API request for which the exception is thrown.

• data: the detailed error information that is returned by the server when an exception occurs.

import com.aliyun.ecs20140526.Client;
import com.aliyun.ecs20140526.models.DescribeInstanceTypeFamiliesRequest;
import com.aliyun.ecs20140526.models.DescribeInstanceTypeFamiliesResponse;
import com.aliyun.tea.TeaException;
import com.aliyun.teaopenapi.models.Config;

public class Sample {
    public static void main(String[] args) {
        try {
            Config config = new Config()
                    .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                    .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
            config.endpoint = "ecs-cn-hangzhou.aliyuncs.com";
            Client client = new Client(config);
            DescribeInstanceTypeFamiliesRequest describeInstanceTypeFamiliesRequest = new DescribeInstanceTypeFamiliesRequest();
            describeInstanceTypeFamiliesRequest.setRegionId("cn-hangzhou");
            DescribeInstanceTypeFamiliesResponse describeInstanceTypeFamiliesResponse = client.describeInstanceTypeFamilies(describeInstanceTypeFamiliesRequest);
        } catch (TeaException teaException) {
            // Handle exceptions with caution in actual business scenarios and never ignore exceptions in your project. In this example, the information is displayed for reference only. 
            // Display the error code.
            System.out.println(teaException.getCode());
            // Display the error message. The error message contains the request ID.
            System.out.println(teaException.getMessage());
            // Display the detailed error information that is returned by the server.
            System.out.println(teaException.getData());
        } catch (Exception e) {
            TeaException error = new TeaException(e.getMessage(), e);
            // Handle exceptions with caution in actual business scenarios and never ignore exceptions in your project. In this example, the information is displayed for reference only. 
            // The error message.
            System.out.println(error.getMessage());
            // The URL of the corresponding error diagnostics.
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }
    }
}