通用流程 - 云服务器 ECS

以云服务器ECS Java SDK查询可用镜像资源的方法DescribeImages为例，介绍编写ECS Java SDK的通用流程。

1. 从IClientProfile类中生成对象Profile。

   Profile对象存放地域、AccessKeyID和AccessKeySecret，如示例中的cn-hangzhou。更多关于地域的信息，请参见地域和可用区。

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

2. 从IClientProfile类中生成IAcsClient的对象client。

   后续获得response从IClientProfile中获得。

   IAcsClient client = new DefaultAcsClient(profile);

3. 创建一个对应方法的Request，使用构造函数生成一个默认的类request。

   类的命名规则为API方法名加上Request。获得镜像列表的API方法名为DescribeImages，对应的请求类名就是DescribeImagesRequest。

   DescribeImagesRequest request = new DescribeImagesRequest();

4. 设置请求类request的参数。
   通过request类的setXxx方法设置必要的信息，即API中必须要提供的信息，通过setXxx方法设置参数。示例中：

   • DescribeImages的API方法RegionId用来指定地域。
   • DescribeImages的API方法ImageOwnerAlias用来设置要查询的镜像类型。设置setImageOwnerAlias的值为system，表示查询公共镜像。

   request.setImageOwnerAlias("system");

5. 通过client对象获得对应request响应。

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

6. 调用response中对应的getXxx方法获得返回的参数值。

   假设您需要获取某份镜像的名字，先通过getImages()获得Image对象的集合，再通过遍历等方法取得其中某个镜像的信息，调用getgetImageName()或者getgetImageId获得具体的信息。

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

   根据API方法的不同，返回的信息中可能会包含多层的信息，如DescribeImages返回的信息中镜像是以一个集合来表示的，集合中存放了每个镜像的信息，汇聚成一个列表。您需要通过getImages()获得Image对象的集合，通过遍历等方法取得其中某个镜像的信息，再调用getXxx方法获得具体的信息。

7. 使用catch()处理服务器报错和客户端报错。
   • 服务端报错

     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());

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());
        }

    }
}