498      阿里云

ARMS Open API 说明__API 参考_业务实时监控服务 ARMS-阿里云

Open API 调用过程

Open API 底层通过 HTTP 接口提供服务，用户调用 Open API 的 SDK，发出 HTTP 请求到应用网关 POP，再由 POP 将请求转发给 ARMS 的后端服务去执行。用户将参数封装到每个请求中，每个请求即对应一个方法。执行的结果放在 response 中。

注意：因为 POP 网关是面对公网环境提供服务的，因此使用 Open API 的前提是，客户端需要能够访问公网服务。否则会提示服务无法连接。

Open API 调用说明

1. 客户端依赖

   公测期间，ARMS Open API 的 SDK 获取方法有2种，一种是下载 SDK 源码，编译后加入到本地的 Maven 仓库中，另一种是下载打包好的 JAR 包，直接导入工程中。

   （1）下载 SDK 源码

   <dependencies>
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-arms</artifactId>
            <version>2.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-core</artifactId>
            <version>2.2.0</version>
        </dependency>
   </dependencies>

   其中 aliyun-java-sdk-arms 的包目前还没有部署到软件仓库中，所以是从官网上下载 SDK 到本地，编译部署到本地的软件仓库中。SDK 的源码下载链接

   （2）下载 JAR 包其中 aliyun-java-sdk-arms 的 JAR 包是从官网上下载 SDK 到本地。SDK的Jar包下载链接。

2. 创建 ACS 客户端说明

    String accessKeyID = "XXX";
    String accessKeySecret = "XXX";
    String region="XXX";
    String endPointName ="XXX";
    String productName = "XXX";
    String domain = "XXX";
    IClientProfile profile = DefaultProfile.getProfile(region, accessKeyID, accessKeySecret);    
    DefaultProfile.addEndpoint(endPointName,region,productName,domain);
    ArmsQueryDataSetRequest armsQueryDataSetRequest = new ArmsQueryDataSetRequest();
    armsQueryDataSetRequest.setXXX(...);
    armsQueryDataSetRequest.setXXX(...);
    IAcsClient client = new DefaultAcsClient(profile);
    ArmsQueryDataSetResponse armsQueryDataSetResponse = client.getAcsResponse(armsQueryDataSetRequest);
    String responseJson = armsQueryDataSetResponse.getdata()

参数说明

pop 参数说明

• region，指的是 API 的网关所在区域，目前支持的有 cn-beijing，cn-hangzhou，cn-qingdao，cn-shenzhen
• accessKey，指的是用户在阿里云官网上获取的 AK
• secretKey，指的是用户在阿里云官网上获得的 SK
• endPointName，接入点名称，例如 cn-hangzhou
• productName，Open API 的产品名称，直接写 ARMS 即可
• domain，目前填写 arms.aliyuncs.com，后续会有扩充

业务参数说明

阿里云将用户所有的请求参数封装在一个 Request 中，返回一个 Response。目前对外开放的 API 有且就有一个：

• 查询用户数据集

• 业务参数详细说明

  ArmsQueryDataSetRequest 包含6个字段：

Dimensions 复合字段说明

• 返回参数ArmsQueryDataSetResponse说明：

    返回值为 JASON 串形式返回，可通过ArmsQueryDataSetResponse.getdata()获取

完整使用示例

    public class TestArmsQueryDataSet {
            public static void main(String[] args) throws ClientException, InterruptedException {
    //设置阿里云公共参数
    String accessKeyID = "XXX";
    String accessKeySecret = "XXX";
    String region = "XXX";
    IClientProfile profile = DefaultProfile.getProfile(region, accessKeyID, accessKeySecret);
    DefaultProfile.addEndpoint(endPointName,region,productName,domain);
    //设置业务参数
    ArmsQueryDataSetRequest armsQueryDataSetRequest = new ArmsQueryDataSetRequest();
    armsQueryDataSetRequest.setDatasetId(XXX);
    armsQueryDataSetRequest.setIntervalInSec(XXX);
    armsQueryDataSetRequest.setMinTime(XXX);
    armsQueryDataSetRequest.setMaxTime(XXX);
    Dimensions dimensions = new Dimensions();
    dimensions.setkey("XXX");
    dimensions.setvalue("XXX");
    List<Dimensions> dimensionss = new ArrayList<Dimensions>();
    dimensionss.add(dimensions);
    List<String> measuress = new ArrayList<String>();
    measuress.add("XXX");
    measuress.add("XXX");
    armsQueryDataSetRequest.setDimensionss(dimensionss);
   armsQueryDataSetRequest.setMeasuress(measuress);
    IAcsClient client = new DefaultAcsClient(profile);
    try {
    //发送请求
        ArmsQueryDataSetResponse armsQueryDataSetResponse = client.getAcsResponse(armsQueryDataSetRequest);
    //获取并打印请求结果
    System.out.println(armsQueryDataSetResponse.getdata());
    } catch (ClientException e) {
        e.printStackTrace();
    }
}

}