查询指定时间段内排序后的云产品时序指标监控数据。

参数说明

  • 各云产品的Project、Metric、Period、Dimensions等入参如何赋值,可查询DescribeMetricMetaList接口或请参考预设监控项参考
  • 开始和结束时间执行的是左开右闭的模式,startTime不能等于或者大于endTime。
  • Cursor是分页模式下的参数,只要存在就说明还有下一页,返回为null则说明没有下一页。
  • Period一般包含60(一分钟)、300(五分钟)、900(十五分钟)。请根据文档以及查询场景的需要考虑Period。比如查询一天范围使用Period为60,则返回1000条数据(实际存在1440,因为最大返回值不超过1000,则只返回前1000条)。如果使用Period为300,则返回288条数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeMetricTop

系统规定参数。取值:DescribeMetricTop。

MetricName String cpu_idle

监控项名称。

Namespace String acs_ecs_dashboard

命名空间,表明监控数据所属产品,例如 “acs_ecs_dashboard”,“acs_rds_dashboard”等。

Dimensions String [{"instanceId": "i-abcdefgh12****"}]

用于查询指定资源的监控数据,是 key-value 形式的集合。常用的key-value集合为“instanceId:XXXXXX”。需要使用 JSON 字符串表示该 Map 对象,传入时请使用字符串,Dimensions字段必须按顺序传入。

EndTime String 2019-01-30 00:10:00

结束时间,可以传入距离1970年1月1日 0点的毫秒数,也可以传入format时间格式数据,如2015-10-20 00:00:00。

Express String {"groupby":["userId","instanceId"]}

对查询出的现有结果进行时时计算的表达式,例如 {"groupby":["instanceId"]}

Length String 1000

每次查询大小,用于分页查询,默认值为1000。

OrderDesc String False

排序方式,可选值:

  • False,由大到小排序。
  • True,由小到大排序。
Orderby String Average

排序字段,即按所填字段进行排序,必填项。

Period String 60

时间间隔,统一用秒数来计算,例如 60, 300, 900。 如果不填写,则按照注册监控项时申明的上报周期来查询原始数据。如果填写统计周期,则查询对应的统计数据 。

StartTime String 2019-01-30 00:00:00

开始时间,可以传入距离1970年1月1日0点的毫秒数,也可以传入format时间格式数据,如2015-10-20 00:00:00。

返回数据

名称 类型 示例值 描述
Code String 200

状态码,200表示成功。

Datapoints String [{"timestamp":1548777660000,"userId":"123","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]

监控数据列表,内容格式例如:{ “timestamp”: 1490164200000, “Maximum”: 100, “userId”: “123456789876****”, “Minimum”: 4.55, “instanceId”: “i-bp18abl200xk9599****”, “Average”: 93.84 }

Message String Success

错误信息,Code为”200”时,Message一般为空。

Period String 60

时间间隔,统一用秒数来计算,例如 60, 300, 900。

RequestId String 3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42

请求ID,用于排查问题。

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeMetricTop
&MetricName=cpu_idle
&Namespace=acs_ecs_dashboard
&<公共请求参数>

正常返回示例

XML 格式

<DescribeMetricTopResponse>
   <Period>60</Period>
      <Datapoints>
            <order>1</order>
            <timestamp>1551687360000</timestamp>
            <userId>12345****</userId>
            <instanceId>i-2zeehst1****</instanceId>
            <Maximum>16.41</Maximum>
            <Minimum>4.66</Minimum>
            <Average>7.74</Average>
            <_count>1</_count>
      </Datapoints>
      <Datapoints>
            <order>2</order>
            <timestamp>1551687360000</timestamp>
            <userId>12345****</userId>
            <instanceId>i-2zefxdy2****</instanceId>
            <Maximum>15.74</Maximum>
            <Minimum>5.03</Minimum>
            <Average>7.14</Average>
            <_count>1</_count>
      </Datapoints>
      <RequestId>1F68A4E8-4488-48E7-9189-3E1F5165E64E</RequestId>
      <Code>200</Code>
</DescribeMetricTopResponse>

JSON 格式

{
	"Period":"60",
	"Datapoints":[
		{
			"timestamp":1551687360000,
			"order":1,
			"_count":1,
			"Maximum":16.41,
			"userId":"12345****",
			"Minimum":4.66,
			"instanceId":"i-2zeehst1****",
			"Average":7.74
		},
		{
			"timestamp":1551687360000,
			"order":2,
			"_count":1,
			"Maximum":15.74,
			"userId":"12345****",
			"Minimum":5.03,
			"instanceId":"i-2zefxdy2****",
			"Average":7.14
		}
	],
	"RequestId":"1F68A4E8-4488-48E7-9189-3E1F5165E64E",
	"Code":"200"
}

错误码

访问错误中心查看更多错误码。