General process

This topic describes how to use the ECS Java SDK by taking DescribeImages as an example. DescribeImages is the operation used by the ECS Java SDK to query available image resources.

1. Generate the profile object from the IClientProfile class.

   The profile object stores the region, AccessKey ID, and AccessKey secret, such as the cn-hangzhou in this example. For more information about regions, see Regions and zones.

   IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", "<yourAccessKeyID>", "<yourAccessKeySecret>");

2. Generate the object client of IAcsClient from the IClientProfile class.

   Subsequently obtain response from IClientProfile.

   IAcsClient client = new DefaultAcsClient(profile);

3. Create a request for the API opertion and use the constructor to generate a default class request.

   The class is named after the API operation name followed by Request. The API operation for obtaining the image list is named DescribeImages and the corresponding request class name is DescribeImagesRequest.

   DescribeImagesRequest request = new DescribeImagesRequest();

4. Set parameters for the request class.
   Set required parameters in the API operation through the setXxx method of the request class. Set parameters through the setXxx method. In the example:

   • The DescribeImages API operation uses RegionId to specify the region.
   • The DescribeImages API operation uses ImageOwnerAlias to specify the image type to be queried. The value of setImageOwnerAlias is system, which indicates public images.

   request.setImageOwnerAlias("system");

5. Obtain the response corresponding to the specified request parameter through the client object.

   DescribeImagesResponse response = client.getAcsResponse(request);
   System.out.println(JSON.toJSONString(response));

6. Obtain the returned parameter value by calling the corresponding getXxx method in response.

   If you need to obtain the name of an image, you must obtain the collection of image objects by calling getImages(), the information of the target image by traversing the image objects, and the details of the image by calling getgetImageName() or getgetImageId.

   for(DescribeImagesResponse.Image image:response.getImages())
               {
                   System.out.println(image.getImageId());
                   System.out.println(image.getImageName());
               }

   Based on different API operations, the response may contain multi-layer information. For example, if you call the DescribeImages operation, the response is represented as a collection in the form of list that stores the information about each image. You must obtain the collection of image objects by calling getImages(), the information of an image by traversing the image objects, and the details of the image by calling getXxx.

7. Handle server and client errors by using catch().
   • Server error

     catch (ServerException e) {
                 e.printStackTrace();

   • Client error

     catch (ClientException e) {
                 System.out.println("ErrCode:" + e.getErrCode());
                 System.out.println("ErrMsg:" + e.getErrMsg());
                 System.out.println("RequestId:" + e.getRequestId());

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.profile.DefaultProfile;
import com.alibaba.fastjson.JSON;
import java.util.*;
import com.aliyuncs.ecs.model.v20140526.*;

public class DescribeImages {

    public static void main(String[] args) {
        DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", "LTAjVUwKznS*****", "BNPO1zoNSi484oizGM9fzzwJJ*****");
        IAcsClient client = new DefaultAcsClient(profile);

        DescribeImagesRequest request = new DescribeImagesRequest();
        request.setRegionId("cn-hangzhou");
        request.setImageOwnerAlias("system");
        request.setPageNumber(1);
        request.setPageSize(1);

        try {
            DescribeImagesResponse response = client.getAcsResponse(request);
            System.out.println(JSON.toJSONString(response));
            for(DescribeImagesResponse.Image image:response.getImages())
            {
                System.out.println(image.getImageId());
                System.out.println(image.getImageName());
            }
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            System.out.println("ErrCode:" + e.getErrCode());
            System.out.println("ErrMsg:" + e.getErrMsg());
            System.out.println("RequestId:" + e.getRequestId());
        }

    }
}