全部产品
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
云监控

查询监控数据

更新时间:2017-12-06 14:26:24

描述

查询一段时间内指定产品实例的监控数据。

请求类型

GET

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:QueryMetricList
Project String 名字空间,表明监控数据所属产品,如 “acs_ecs_dashboard”,“acs_rds_dashboard”等
Metric String 监控项名称
Period String 时间间隔,统一用秒数来计算,例如 60, 300, 900。 如果不填写,则按照注册监控项时申明的上报周期来查询原始数据。如果填写统计周期,则查询对应的统计数据 。
StartTime String 开始时间,可以传入距离1970年1月1日0点的毫秒数,也可以传入format数据,如2015-10-20 00:00:00。
EndTime String 可以传入距离1970年1月1日 0点的毫秒数,也可以传入format数据,如2015-10-20 00:00:00
Dimensions String 用于过滤监控数据的 key-value 集合,key 可以使用注册监控项时申明的 dimensionKeys 中的一个或多个,value 为该 key 对应的值。instanceId 是必填项 需要使用 JSON 字符串表示该 Map 对象,传入时请使用字符串,dimension要求必须按顺序传入
Length String 每次查询大小,用于分页查询,默认值为1000。
Cursor String 游标

各云产品的Project、Metric、Period、Dimensions等入参如何赋值,请参考预设监控项文档

参数说明

  • 批量查询实例的监控数据:在Dimensions参数中,使用JSON格式传入多个实例Id,即可查询多实例数据。示例:[{“instanceId”:”“},{“instanceId”:”“},{“instanceId”:”“},{“instanceId”:”“}]
  • Project、Metric 、Period、Dimensions如何赋值,请查看预设监控项参考。
  • 开始和结束时间执行的是左开右闭的模式,startTime不能等于或者大于endTime。
  • Cursor是分页模式下的参数,只要存在就说明还有下一页,返回为null则说明没有下一页。
  • Period一般包含60(一分钟)、300(五分钟)、900(十五分钟)。请根据文档以及查询场景的需要考虑period。比如查询一天范围使用period=60,则返回1000条数据(实际存在1440,因为最大返回值不超过1000,则只返回前1000条)。如果使用period=300,则返回288条数据。
  • 本接口支持RAM子账号调用,授权时操作描述符为:“cms:QueryMetricList”,资源描述符为:“*”。

返回参数

名称 类型 描述
Period String 时间间隔,统一用秒数来计算,例如 60, 300, 900。
Cursor String 游标
Datapoints String 监控数据列表,内容格式例如:{ “timestamp”: 1490164200000, “Maximum”: 100, “userId”: “1234567898765432”, “Minimum”: 4.55, “instanceId”: “i-bp18abl200xk9599ck7c”, “Average”: 93.84 }
Code String 状态码,正常为”200”。
Success Boolean 否成功执行,如果服务器端有异常此返回值为false,正常为true。
Message String 状态描述信息,Code为”200”时,Message一般为空。
RequestId String 当请求出现问题时,可以提供此字段给技术人员进行问题排查。

错误编码

错误代码 描述 语义
400 Bad Request 客户端请求中的语法错误
403 Forbidden 没有权限
404 Not Found 客户端错误,未找到
500 Internal Server Error 服务器内部错误
200 OK 正常

示例

  • 请求示例
  1. http://metrics.cn-hangzhou.aliyuncs.com/?Action=QueryMetricList
  2. &EndTime=2017-05-17+11%3A30%3A27
  3. &StartTime=2017-05-17+11%3A20%3A27
  4. &Period=60
  5. &Dimensions=%7B%22instanceId%22%3A%22i-abcdefgh123456%22%7D
  6. &Timestamp=2017-03-22T09%3A30%3A57Z
  7. &Project=acs_ecs_dashboard
  8. &Metric=cpu_idle
  • 返回示例

XML格式

  1. <QueryMetricListResponse>
  2. <Period>60</Period>
  3. <Datapoints>
  4. <Datapoints>
  5. <timestamp>1490152860000</timestamp>
  6. <Maximum>100</Maximum>
  7. <userId> 1234567898765432</userId>
  8. <Minimum>93.1</Minimum>
  9. <instanceId>i-abcdefgh123456</instanceId>
  10. <Average>99.52</Average>
  11. </Datapoints>
  12. <Datapoints>
  13. <timestamp>1490152920000</timestamp>
  14. <Maximum>100</Maximum>
  15. <userId> 1234567898765432 </userId>
  16. <Minimum>92.59</Minimum>
  17. <instanceId>i-abcdefgh123456</instanceId>
  18. <Average>99.49</Average>
  19. </Datapoints>
  20. <Datapoints>
  21. <timestamp>1490152980000</timestamp>
  22. <Maximum>100</Maximum>
  23. <userId>1234567898765432</userId>
  24. <Minimum>92.86</Minimum>
  25. <instanceId>i-abcdefgh123456</instanceId>
  26. <Average>99.44</Average>
  27. </Datapoints>
  28. <Datapoints>
  29. <timestamp>1490153040000</timestamp>
  30. <Maximum>100</Maximum>
  31. <userId>1234567898765432</userId>
  32. <Minimum>91.43</Minimum>
  33. <instanceId>i-abcdefgh123456</instanceId>
  34. <Average>99.36</Average>
  35. </Datapoints>
  36. <Datapoints>
  37. <timestamp>1490153100000</timestamp>
  38. <Maximum>100</Maximum>
  39. <userId>1234567898765432</userId>
  40. <Minimum>93.55</Minimum>
  41. <instanceId>i-abcdefgh123456</instanceId>
  42. <Average>99.51</Average>
  43. </Datapoints>
  44. <Datapoints>
  45. <timestamp>1490153160000</timestamp>
  46. <Maximum>100</Maximum>
  47. <userId>1234567898765432</userId>
  48. <Minimum>93.1</Minimum>
  49. <instanceId>i-abcdefgh123456</instanceId>
  50. <Average>99.52</Average>
  51. </Datapoints>
  52. <Datapoints>
  53. <timestamp>1490153220000</timestamp>
  54. <Maximum>100</Maximum>
  55. <userId>1234567898765432</userId>
  56. <Minimum>92.59</Minimum>
  57. <instanceId>i-abcdefgh123456</instanceId>
  58. <Average>99.42</Average>
  59. </Datapoints>
  60. <Datapoints>
  61. <timestamp>1490153280000</timestamp>
  62. <Maximum>100</Maximum>
  63. <userId>1234567898765432</userId>
  64. <Minimum>91.18</Minimum>
  65. <instanceId>i-abcdefgh123456</instanceId>
  66. <Average>99.34</Average>
  67. </Datapoints>
  68. <Datapoints>
  69. <timestamp>1490153340000</timestamp>
  70. <Maximum>100</Maximum>
  71. <userId>1234567898765432</userId>
  72. <Minimum>92.86</Minimum>
  73. <instanceId>i-abcdefgh123456</instanceId>
  74. <Average>99.46</Average>
  75. </Datapoints>
  76. <Datapoints>
  77. <timestamp>1490153400000</timestamp>
  78. <Maximum>100</Maximum>
  79. <userId>1234567898765432</userId>
  80. <Minimum>91.18</Minimum>
  81. <instanceId>i-abcdefgh123456</instanceId>
  82. <Average>99.35</Average>
  83. </Datapoints>
  84. </Datapoints>
  85. <RequestId>6661EC50-8625-4161-B349-E0DD59002AB7</RequestId>
  86. <Success>true</Success>
  87. <Code>200</Code>
  88. </QueryMetricListResponse>

JSON格式

  1. {
  2. "Period": "60",
  3. "Datapoints": [
  4. {
  5. "timestamp": 1490152860000,
  6. "Maximum": 100,
  7. "userId": "1234567898765432",
  8. "Minimum": 93.1,
  9. "instanceId": "i-abcdefgh123456",
  10. "Average": 99.52
  11. },
  12. {
  13. "timestamp": 1490152920000,
  14. "Maximum": 100,
  15. "userId": "1234567898765432",
  16. "Minimum": 92.59,
  17. "instanceId": "i-abcdefgh123456",
  18. "Average": 99.49
  19. },
  20. {
  21. "timestamp": 1490152980000,
  22. "Maximum": 100,
  23. "userId": "1234567898765432",
  24. "Minimum": 92.86,
  25. "instanceId": "i-abcdefgh123456",
  26. "Average": 99.44
  27. },
  28. {
  29. "timestamp": 1490153040000,
  30. "Maximum": 100,
  31. "userId": "1234567898765432",
  32. "Minimum": 91.43,
  33. "instanceId": "i-abcdefgh123456",
  34. "Average": 99.36
  35. },
  36. {
  37. "timestamp": 1490153100000,
  38. "Maximum": 100,
  39. "userId": "1234567898765432",
  40. "Minimum": 93.55,
  41. "instanceId": "i-abcdefgh123456",
  42. "Average": 99.51
  43. },
  44. {
  45. "timestamp": 1490153160000,
  46. "Maximum": 100,
  47. "userId": "1234567898765432",
  48. "Minimum": 93.1,
  49. "instanceId": "i-abcdefgh123456",
  50. "Average": 99.52
  51. },
  52. {
  53. "timestamp": 1490153220000,
  54. "Maximum": 100,
  55. "userId": "1234567898765432",
  56. "Minimum": 92.59,
  57. "instanceId": "i-abcdefgh123456",
  58. "Average": 99.42
  59. },
  60. {
  61. "timestamp": 1490153280000,
  62. "Maximum": 100,
  63. "userId": "1234567898765432",
  64. "Minimum": 91.18,
  65. "instanceId": "i-abcdefgh123456",
  66. "Average": 99.34
  67. },
  68. {
  69. "timestamp": 1490153340000,
  70. "Maximum": 100,
  71. "userId": "1234567898765432",
  72. "Minimum": 92.86,
  73. "instanceId": "i-abcdefgh123456",
  74. "Average": 99.46
  75. },
  76. {
  77. "timestamp": 1490153400000,
  78. "Maximum": 100,
  79. "userId": "1234567898765432",
  80. "Minimum": 91.18,
  81. "instanceId": "i-abcdefgh123456",
  82. "Average": 99.35
  83. }
  84. ],
  85. "RequestId": "6A5F022D-AC7C-460E-94AE-B9E75083D027",
  86. "Success": true,
  87. "Code": "200"
  88. }
本文导读目录