全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
业务实时监控服务 ARMS

通用查询数据集接口

更新时间:2017-09-13 14:32:06

POP 参数说明

业务参数说明

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

  • 查询用户数据集
API 功能 Request Response
ARMSQueryDataSet ARMSQueryDataSetRequest ARMSQueryDataSetResponse
  • 业务参数详细说明

    ARMSQueryDataSetRequest 包含6个字段:

字段名称 字段类型 设置方法 字段含义 是否必选 备注
datasetId Long setDatasetId 数据集ID
minTime Long setMinTime 查询数据的起始时间
maxTime Long setMaxTime 查询数据的截止时间
intervalInSec Integer setIntervalInSec 数据片的时间间隔
dimensions List[Dimension] setDimensions 查询维度列表 Dimensions 为复合参数,列表最长支持3个元素。如果为空,则按第一个维度查询数据
measures List[String] setMesures 查询指标列表 列表最长支持3个元素。如果为空,则返回所有指标数据
isDrillDown Boolean setIsDrillDown 是否下钻
  • Dimensions 复合字段说明
字段名称 字段类型 设置方法 字段含义 备注
key String setKey 维度名称 如:区域
value String setValue 维度值 如:北京
  • 返回参数 ARMSQueryDataSetResponse 说明:

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

完整使用示例

  1. import java.util.ArrayList;
  2. import java.util.List;
  3. import com.aliyuncs.DefaultAcsClient;
  4. import com.aliyuncs.IAcsClient;
  5. import com.aliyuncs.arms.model.v20161125.ARMSQueryDataSetRequest;
  6. import com.aliyuncs.arms.model.v20161125.ARMSQueryDataSetRequest.Dimensions;
  7. import com.aliyuncs.arms.model.v20161125.ARMSQueryDataSetResponse;
  8. import com.aliyuncs.exceptions.ClientException;
  9. import com.aliyuncs.profile.DefaultProfile;
  10. import com.aliyuncs.profile.IClientProfile;
  11. public class ARMSGeneralQuery
  12. {
  13. public static void main(String[] args) throws ClientException {
  14. // 用户主账号的AK,在阿里云控制台上查看获取
  15. String accessKeyId = "xxx";
  16. // 用户主账号的SK,在阿里云控制台上查看获取
  17. String accessKeySecret = "xxx";
  18. //Region和endpoint保持一致,具体内容和ARMS的region绑定,
  19. //目前支持cn-hangzhou和cn-beijing两种,填哪个由ARMS控制台的region为准。
  20. String endpoint = "cn-hangzhou";
  21. String region = "cn-hangzhou";
  22. //产品名请固定填"ARMS"
  23. String productName = "ARMS";
  24. //如果是非杭州区域,请改写,如cn-beijing,
  25. String domain = "arms.cn-hangzhou.aliyuncs.com";
  26. IClientProfile profile = DefaultProfile.getProfile(region, accessKeyId, accessKeySecret);
  27. DefaultProfile.addEndpoint(endpoint, region, productName, domain);
  28. // 设置业务参数
  29. ARMSQueryDataSetRequest armsQueryDataSetRequest = new ARMSQueryDataSetRequest();
  30. //DatasetID在数据集管理页面上可查询到
  31. armsQueryDataSetRequest.setDatasetId(1340l);
  32. //查询数据的返回间隔,请务必自行保证为60的倍数
  33. armsQueryDataSetRequest.setIntervalInSec(60);
  34. //设置查询的起始时间,该例子为查询最近60秒数据,注意单位为毫秒
  35. armsQueryDataSetRequest.setMinTime(System.currentTimeMillis() - 60000);
  36. armsQueryDataSetRequest.setMaxTime(System.currentTimeMillis());
  37. //以下例子为设置查询维度,该例子中,查询维度Key为区域,Value为上海
  38. Dimensions dimensions = new Dimensions();
  39. dimensions.setKey("区域");
  40. dimensions.setValue("上海");
  41. List<Dimensions> dimensionss = new ArrayList<Dimensions>();
  42. dimensionss.add(dimensions);
  43. //选择要读取的统计值,该例子中,查询的值为价格和数量
  44. List<String> measuress = new ArrayList<String>();
  45. measuress.add("价格");
  46. measuress.add("数量");
  47. armsQueryDataSetRequest.setDimensionss(dimensionss);
  48. armsQueryDataSetRequest.setMeasuress(measuress);
  49. //如果设置为false,则返回指定Dimension的单维数据,
  50. //如果设置为true,则返回指定Dimension以下的多维数据
  51. armsQueryDataSetRequest.setIsDrillDown(false);
  52. IAcsClient client = new DefaultAcsClient(profile);
  53. try {
  54. //发送请求
  55. ARMSQueryDataSetResponse armsQueryDataSetResponse = client.getAcsResponse(armsQueryDataSetRequest);
  56. //获取并打印请求结果
  57. System.out.println(armsQueryDataSetResponse.getData());
  58. } catch (ClientException e) {
  59. e.printStackTrace();
  60. }
  61. }
  62. }
本文导读目录