调用DescribeMetricTop接口先查询指定云产品的指定监控项的最新监控数据，再查询该监控项排序后的监控数据。

使用限制

单个API的调用次数限制为10次/秒。一个阿里云账号及该账号下的RAM用户共用10次/秒。

注意事项

各云产品监控数据的存储时长与Period（统计周期）有关，Period越大，查询的监控数据越稀疏，监控数据的存储时间越长，具体关系如下：

  • Period小于60秒，存储时长为7天。
  • Period等于60秒，存储时长为31天。
  • Period等于300秒，存储时长为91天。

使用说明

本文将提供一个示例，查询云服务acs_ecs_dashboard监控项cpu_idle在最近60秒的监控数据，并对监控数据的Average从大到小排序。

调试

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

请求参数

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

要执行的操作，取值：DescribeMetricTop。
Period String 否 60

监控数据的统计周期。

取值：15、60、900和3600。

单位：秒。

说明
  • 如果不设置统计周期，则按照注册监控项时申请的上报周期来查询监控数据。
  • 每个云产品的监控项（MetricName）的统计周期不同。更多信息，请参见云产品监控项。
Namespace String 是 acs_ecs_dashboard

云产品的数据命名空间。

关于云产品的数据命名空间，请参见云产品监控项。
MetricName String 是 cpu_idle

云产品的监控项名称。

关于监控项名称，请参见云产品监控项。
StartTime String 否 2021-05-08 08:00:00

查询监控数据的开始时间。

  • 当您未设置StartTime和EndTime时，查询当前时间最近一个统计周期Period的监控数据。
  • 当您同时设置StartTime和EndTime时，查询指定时间段内距离EndTime最近一个统计周期Period的监控数据。具体如下：
    • 当Period设置为15秒时，指定时间段必须小于或等于20分钟。例如：StartTime为2021-05-08 08:10:00，EndTime为2021-05-08 08:30:00，统计距离2021-05-08 08:30:00最近一个15秒的监控数据。
    • 当Period设置为60秒或900秒时，指定时间段必须小于或等于2小时。例如：Period为60秒，StartTime为2021-05-08 08:00:00，EndTime为2021-05-08 10:00:00，统计距离2021-05-08 10:00:00最近一个60秒的监控数据。
    • 当Period设置为3600秒时，指定时间段必须小于或等于2天。例如：StartTime为2021-05-08 08:00:00，EndTime为2021-05-10 08:00:00，统计距离2021-05-10 08:00:00最近一个3600秒的监控数据。

开始时间支持的格式：

  • Unix时间戳：从1970年1月1日开始所经过的毫秒数。
  • Format格式：YYYY-MM-DDThh:mm:ssZ。
说明
  • StartTime如果设置过早，则无效。
  • 建议您使用Unix时间戳，避免时区的问题。
EndTime String 否 2021-05-08 10:00:00

查询监控数据的结束时间。

  • 当您未设置StartTime和EndTime时，查询当前时间最近一个统计周期Period的监控数据。
  • 当您同时设置StartTime和EndTime时，查询指定时间段内距离EndTime最近一个统计周期Period的监控数据。具体如下：
    • 当Period设置为15秒时，指定时间段必须小于或等于20分钟。例如：StartTime为2021-05-08 08:10:00，EndTime为2021-05-08 08:30:00，统计距离2021-05-08 08:30:00最近一个15秒的监控数据。
    • 当Period设置为60秒或900秒时，指定时间段必须小于或等于2小时。例如：Period为60秒，StartTime为2021-05-08 08:00:00，EndTime为2021-05-08 10:00:00，统计距离2021-05-08 10:00:00最近一个60秒的监控数据。
    • 当Period设置为3600秒时，指定时间段必须小于或等于2天。例如：StartTime为2021-05-08 08:00:00，EndTime为2021-05-10 08:00:00，统计距离2021-05-10 08:00:00最近一个3600秒的监控数据。

结束时间支持的格式：

  • Unix时间戳：从1970年1月1日开始所经过的毫秒数。
  • Format格式：YYYY-MM-DDThh:mm:ssZ。
说明 建议您使用Unix时间戳，避免时区的问题。
Dimensions String 否 [{"instanceId": "i-2ze2d6j5uhg20x47****"}]

指定资源的监控维度。

格式：key:value键值对形式的集合，例如：{"userId":"120886317861****"}和{"instanceId":"i-2ze2d6j5uhg20x47****"}。

说明 单次请求最多支持批量查询50个实例。
Orderby String 是 Average

排序字段，即按该字段进行排序。取值：

  • Average：平均值。
  • Minimum：最小值。
  • Maximum：最大值。
OrderDesc String 否 False

排序方式。取值：

  • True：由小到大排序。
  • False（默认值）：由大到小排序。
Length String 否 10

每页显示的记录条数。

用于分页查询，默认值：10。

说明 单次请求Length的最大值为1440。
Express String 否 {"groupby":["userId","instanceId"]}

对查询出的现有结果进行实时计算的表达式。

说明 目前仅支持groupby（类似数据库的groupby语句）。

关于公共请求参数的详情，请参见公共参数。

返回数据

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

状态码。

说明 200表示成功。
Message String The specified resource is not found.

错误信息。
RequestId String 3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42

请求ID。
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。

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/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格式

HTTP/1.1 200 OK
Content-Type:application/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. 未找到指定资源。

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