498      windows

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

}