调用DescribeMetricTop接口先查询指定云服务的指定监控项的最新监控数据,再查询该监控项排序后的监控数据。
本文将提供一个示例,查询云服务acs_ecs_dashboard
监控项cpu_idle
在最近60秒的监控数据,并对监控数据的Average
从大到小排序。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeMetricTop |
要执行的操作,取值:DescribeMetricTop。 |
MetricName | String | 是 | cpu_idle |
云服务的监控项名称。更多信息,请参见云服务监控项。 |
Namespace | String | 是 | acs_ecs_dashboard |
云服务的数据命名空间。更多信息,请参见云服务监控项。 |
Orderby | String | 是 | Average |
排序字段,即按该字段进行排序。取值:
|
Period | String | 否 | 60 |
监控数据的统计周期。单位:秒。取值:15、60、900和3600。 说明 如果不设置统计周期,则按照注册监控项时申请的上报周期来查询监控数据。
|
StartTime | String | 否 | 2021-05-08 08:00:00 |
查询监控数据的开始时间。
开始时间支持的格式:
说明
|
EndTime | String | 否 | 2021-05-08 10:00:00 |
查询监控数据的结束时间。
结束时间支持的格式:
说明 建议您使用Unix时间戳,避免时区的问题。
|
Dimensions | String | 否 | [{"instanceId": "i-abcdefgh12****"}] |
维度Map,用于查询指定资源的监控数据。 格式:key-value键值对形式的集合,常用的key-value集合为 说明 Dimensions传入时需要使用JSON字符串表示该Map对象,必须按顺序传入。
|
OrderDesc | String | 否 | False |
排序方式。取值:
|
Length | String | 否 | 10 |
每页显示的记录条数。用于分页查询,默认值:10。 |
Express | String | 否 | {"groupby":["userId","instanceId"]} |
对查询出的现有结果进行实时计算的表达式。 目前仅支持 |
关于公共请求参数的详情,请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42 |
请求ID。 |
Code | String | 200 |
状态码。 说明 200表示成功。
|
Datapoints | String | [{\"order\":1,\"timestamp\":1620287520000,\"userId\":\"120886317861****\",\"instanceId\":\"i-j6ccf7d5fn335qpo****\",\"Average\":99.92,\"Minimum\":99.5,\"Maximum\":100.0,\"_count\":1.0},{\"order\":2,\"timestamp\":1620287520000,\"userId\":\"120886317861****\",\"instanceId\":\"i-0xii2bvf42iqvxbp****\",\"Average\":99.91,\"Minimum\":99.0,\"Maximum\":100.0,\"_count\":1.0}] |
监控数据列表。 |
Period | String | 60 |
监控数据的统计周期。单位:秒。取值:15、60、900和3600。 |
Message | String | The specified resource is not found. |
错误信息。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeMetricTop
&MetricName=cpu_idle
&Namespace=acs_ecs_dashboard
&Period=60
&Orderby=Average
&OrderDesc=False
&<公共请求参数>
正常返回示例
XML
格式
<DescribeMetricTopResponse>
<RequestId>18DC44ED-B058-49B0-9D49-1D6608328E4D</RequestId>
<Period>60</Period>
<Datapoints>[{\"order\":1,\"timestamp\":1620287520000,\"userId\":\"120886317861****\",\"instanceId\":\"i-j6ccf7d5fn335qpo****\",\"Average\":99.92,\"Minimum\":99.5,\"Maximum\":100.0,\"_count\":1.0},{\"order\":2,\"timestamp\":1620287520000,\"userId\":\"120886317861****\",\"instanceId\":\"i-0xii2bvf42iqvxbp****\",\"Average\":99.91,\"Minimum\":99.0,\"Maximum\":100.0,\"_count\":1.0}]</Datapoints>
<Code>200</Code>
</DescribeMetricTopResponse>
JSON
格式
{
"RequestId": "18DC44ED-B058-49B0-9D49-1D6608328E4D",
"Period": "60",
"Datapoints": "[{\"order\":1,\"timestamp\":1620287520000,\"userId\":\"120886317861****\",\"instanceId\":\"i-j6ccf7d5fn335qpo****\",\"Average\":99.92,\"Minimum\":99.5,\"Maximum\":100.0,\"_count\":1.0},{\"order\":2,\"timestamp\":1620287520000,\"userId\":\"120886317861****\",\"instanceId\":\"i-0xii2bvf42iqvxbp****\",\"Average\":99.91,\"Minimum\":99.0,\"Maximum\":100.0,\"_count\":1.0}]",
"Code": "200"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | ResourceNotFound | The specified resource is not found. | 未找到指定资源。 |
访问错误中心查看更多错误码。