通用数据集查询接口

本文介绍了通用数据集查询接口。关于下钻数据集和通用数据集的区别，请参考通用维度与下钻维度。

描述

查询接口与“下钻数据集”相同，ARMSQueryDataSet 主要用于查询 ARMS 中的数据集的数据。

请求参数

请求参数包含 POP 公共参数和业务参数两个部分。公共请求参数请参考 POP 参数说明。

业务参数说明

阿里云将用户所有的请求参数封装在一个 Request 中，返回一个 Response。

ARMSQueryDataSetRequest 包含以下字段：

RequiredDims(OptionalDims) 复合字段说明

• 当您想选择该维度下面的所有的维度值时，type 设置为 ALL，value 为 null。
• 当您想选择该维度下面的其中某个维度值时，type 设置为 STATIC（静态值），value 为输入维度值。
• 当您不想选择该维度时候，可以直接忽略，或者将 type 设置为 DISABLED。

返回参数

返回值为 JSON 串形式返回，可通过 ARMSQueryDataSetResponse.getdata() 获取。

ARMSQueryDataSetResponse 主要字段有：

完整使用示例

1. 在不选择维度情况下，查询所有数据的汇总信息（没有设置必选维度）：

   JavaPythonPHP

   import java.util.ArrayList;
   import java.util.List;
   import com.aliyuncs.DefaultAcsClient;
   import com.aliyuncs.IAcsClient;
   import com.aliyuncs.arms.model.v20180620.ARMSQueryDataSetRequest;
   import com.aliyuncs.arms.model.v20180620.ARMSQueryDataSetRequest.Dimensions;
   import com.aliyuncs.arms.model.v20180620.ARMSQueryDataSetResponse;
   import com.aliyuncs.exceptions.ClientException;
   import com.aliyuncs.profile.DefaultProfile;
   import com.aliyuncs.profile.IClientProfile;
   public class ARMSGeneralQuery {
    public static void main(String[] args) throws ClientException {
      // 用户主账号/RAM 子账号的 AK，或者 RAM 用户角色的临时安全令牌的 AK
      String accessKeyId = "xxx";
      // 用户主账号/RAM 子账号的 SK，或者 RAM 用户角色的临时安全令牌的 SK
      String accessKeySecret = "xxx";
      //Region和endpoint保持一致，具体内容和ARMS的region绑定，
      String endpoint = "xxx";//例如 cn-hangzhou
      String region = "xxx";//例如 cn-hangzhou
      //产品名请固定填"ARMS"
      String productName = "ARMS";
      //如果是非杭州区域，请改写，如cn-beijing，
      String domain = "arms.cn-hangzhou.aliyuncs.com";
      IClientProfile profile = DefaultProfile.getProfile(region, accessKeyId, accessKeySecret);
      DefaultProfile.addEndpoint(endpoint, region, productName, domain);
      // 设置业务参数
      ARMSQueryDataSetRequest armsQueryDataSetRequest = new ARMSQueryDataSetRequest();
      //DatasetID在数据集管理页面上可查询到
      armsQueryDataSetRequest.setDatasetId(1340l);
      //查询数据的返回间隔，请务必自行保证为60的倍数
      armsQueryDataSetRequest.setIntervalInSec(60);
      //设置查询的起始时间，该例子为查询最近十分钟数据，注意单位为毫秒
      armsQueryDataSetRequest.setMinTime(System.currentTimeMillis() - 600000);
      armsQueryDataSetRequest.setMaxTime(System.currentTimeMillis());
      // ****后续的2、3示例代码插入此处****
      IAcsClient client = new DefaultAcsClient(profile);
      try {
        //发送请求
        ARMSQueryDataSetResponse armsQueryDataSetResponse = client.getAcsResponse(armsQueryDataSetRequest);
        //获取并打印请求结果
        System.out.println(armsQueryDataSetResponse.getData());
      } catch (ClientException e) {
        e.printStackTrace();
      }
    }
   }

   #!/usr/bin/env python
   #encoding: utf-8
   from aliyunsdkcore import client
   from aliyunsdkarms.request.v20180620 import ARMSQueryDataSetRequest
   import time
   def main():
      #设置阿里云公共参数, 请参考本页顶部[POP参数说明]。
      #关于 Region 的详细信息请参考本文末尾的参考文档《ARMS Open API 概述》
      region = 'cn-hangzhou'
      #用户主账号/RAM 子账号的 SK，或者 RAM 用户角色的临时安全令牌的 SK
      accessKeyID = 'xxx'
      accessKeySecret = 'xxx'
      #构造client
      clt = client.AcsClient(accessKeyID, accessKeySecret, region)
      #构造业务参数
      armsQueryDataSetRequest = ARMSQueryDataSetRequest.ARMSQueryDataSetRequest()
      #填写正确的数据集ID，在在ARMS数据集管理页面确定
      armsQueryDataSetRequest.set_DatasetId(12221L)
      #设置查询间隔时间，在本例中为60秒
      armsQueryDataSetRequest.set_IntervalInSec(60)
      #设置查询时间的间隔，本例中为最近一个小时，注意单位为毫秒，必须为整型
      armsQueryDataSetRequest.set_MinTime(int(time.time()*1000)-3600000)
      armsQueryDataSetRequest.set_MaxTime(int(time.time()*1000))
      // ****后续的2、3示例代码插入此处****
      #发送请求
      armsQueryDataSetResponse = clt.do_action(armsQueryDataSetRequest)
      #打印请求结果
      print armsQueryDataSetResponse
   if __name__ == '__main__':
      main()

   include_once 'aliyun-php-sdk-core/Config.php';
   include_once 'aliyun-php-sdk-arms/ARMS/Request/V20180620/ARMSQueryDataSetRequest.php';
   include_once 'aliyun-php-sdk-arms/ARMS/Request/V20180620/WhereInDimQueryRequest.php';
   use ARMS\Request\V20180620\ARMSQueryDataSetRequest as ARMSQueryDataSetRequest;
   //设置连接参数，其中，endpoint为例如 "cn-hangzhou"，"cn-beijing"，等, AK, SK请根据您的实际情况填写，
   $iClientProfile = DefaultProfile::getProfile("cn-hangzhou", "your_ak", "your_sk");
   $client = new DefaultAcsClient($iClientProfile);
   $request = new ARMSQueryDataSetRequest();
   //填写正确的数据集ID
   $request->setDatasetId(12221);
   //时间粒度，比如为60秒
   $request->setIntervalInSec(60);
   //最小时间，本例为当前时间的一小时前
   $request->setMinTime((int)time()*1000 - 3600000);
   //最大时间，可设置为当前时间
   $request->setMaxTime((int)time()*1000);
   // ****后续的2、3示例代码插入此处****
   //发送请求
   $response = $client->doAction($request);
   //打印请求
   print_r( $response->getBody());

2. 请检查您是否配置了“必选维度”。如果没有配置，请忽略该本注意事项。如果配置了“必选维度”，那么在查询时一定要设置“必选维度”相关配置，否则无法进行查询。

   JavaPythonPHP

   ARMSQueryDataSetRequest.RequiredDims dimensions = new ARMSQueryDataSetRequest.RequiredDims();
   dimensions.setKey("code");//必选维度名称
   dimensions.setValue("CODE");//必选维度值
   dimensions.setType("STATIC");//统一填写STATIC
   List<ARMSQueryDataSetRequest.RequiredDims> dimensionss = new  ArrayList<ARMSQueryDataSetRequest.RequiredDims>();
   dimensionss.add(dimensions);
   armsQueryDataSetRequest.setRequiredDimss(dimensionss);

   requireddims = [{"Key":"code","Value":"CODE", "Type":"STATIC"}]
   armsQueryDataSetRequest.set_RequiredDims(requireddims)

   $requireddims = array (array("Key"=>"类目", "Value" => "女装", "Type" => "STATIC"));
   $request->setRequiredDims($requireddims);

3. 选择要查询的指标列表，返回结果只返回您指定的指标：

   JavaPythonPHP

   List<String> measuress = new ArrayList<String>();
   measuress.add("价格");
   measuress.add("数量");
   armsQueryDataSetRequest.setMeasuress(measuress);

   measures = ["COUNT__line"]
   armsQueryDataSetRequest.set_Measuress(measures)

   $measures = array ("COUNT__line");
   $request->setMeasuress($measures);

参考

• ARMS Open API 概述