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

各云产品的Namespace、Orderby、Project、Metric、Period、Dimensions等参数的取值，请参见DescribeMetricMetaList或云监控主要监控项。

调试

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

请求参数

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

系统规定参数。取值：DescribeMetricTop。
MetricName String 是 cpu_idle

监控项名称。
Namespace String 是 acs_ecs_dashboard

产品的数据命名空间，用于区分不同的产品。

命名方式：acs_产品名。
Orderby String 是 Average

排序字段，即按该排序字段进行排序，此参数为必填项。
Dimensions String 否 [{"instanceId": "i-abcdefgh12****"}]

维度map，用于查询指定资源的监控数据。

格式为key-value键值对形式的集合，常用的key-value集合为instanceId：XXXXXX。

key和value的长度为1~64个字节，超过64个字节时截取前64字节。key和value的取值可包含字母、数字、点号（.）、短横线（-）、下划线（_）、正斜线（/）和反斜线（\）。

说明 Dimensions传入时需要使用JSON字符串表示该Map对象，必须按顺序传入。
EndTime String 否 2019-01-30 00:10:00

结束时间。支持的格式：

  • Unix时间戳：从1970年1月1日开始所经过的秒数。
  • Format格式：YYYY-MM-DDThh:mm:ssZ。
Express String 否 {"groupby":["userId","instanceId"]}

对查询出的现有结果进行实时计算的表达式。目前仅支持groupby（类似数据库的groupby语句）。

Length String 否 1000

每页显示的记录条数，用于分页查询，默认值为1000。
OrderDesc String 否 False

排序方式。取值：

  • True：由小到大排序
  • False：由大到小排序
Period String 否 60

时间间隔，单位为秒。取值一般为60（1分钟）、300（5分钟）、900（15分钟）。

说明 请根据需要设置此参数。例如查询一天范围时设置Period为60，则返回1000条数据（实际存在1440，因为最大返回值不超过1000，则只返回前1000条）。如果使用Period为300，则返回288条数据。
StartTime String 否 2019-01-30 00:00:00

开始时间。支持的格式：

  • Unix时间戳：从1970年1月1日开始所经过的秒数。
  • Format格式：YYYY-MM-DDThh:mm:ssZ。
说明 开始和结束时间执行的是左开右闭的模式，startTime不能等于或大于endTime。

返回数据

名称 类型 示例值 描述
RequestId String 3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42

请求ID。
Code String 200

状态码。

说明 状态码为200表示成功。
Datapoints String [{"timestamp":1548777660000,"userId":"123","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]

监控数据列表。
Period String 60

时间间隔，单位为秒。取值为60、300、900。
Message String Success

错误信息。

示例

请求示例


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

正常返回示例

XML 格式 

<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>

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"
}

错误码

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