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

本文将提供一个示例,查询云服务acs_ecs_dashboard监控项cpu_idle在60秒内的平均监控数据。

调试

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

请求参数

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

要执行的操作,取值:DescribeMetricTop。

MetricName String cpu_idle

监控项名称。更多信息,请参见云服务监控项

Namespace String acs_ecs_dashboard

云服务的数据命名空间。更多信息,请参见云服务监控项

Orderby String Average

排序字段,即按该字段进行排序。取值:

  • Average:平均值。
  • Minimum:最小值。
  • Maximum:最大值。
Period String 60

时间间隔。单位:秒。取值:60、300、900。默认值:60。

请根据您的实际需求设置该参数。例如:

  • 当Period设置为60时,如果实际存在1440条数据,则只返回1000条数据。
  • 当Period设置为300时,如果实际存在288条数据,则返回288条数据。
说明 由于最大返回值不超过1000条数据,因此当其超过1000条数据时,只返回前1000条。
StartTime String 2019-01-30 00:00:00

开始时间。支持的格式:

  • Unix时间戳:从1970年1月1日开始所经过的毫秒数。
  • Format格式:YYYY-MM-DDThh:mm:ssZ。
说明 开始和结束时间执行的是左开右闭的模式,StartTime不能等于或大于EndTime。
EndTime String 2019-01-30 00:10:00

结束时间。支持的格式:

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

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

格式:key-value键值对形式的集合,常用的key-value集合为instanceId:i-2ze2d6j5uhg20x47****

说明 Dimensions传入时需要使用JSON字符串表示该Map对象,必须按顺序传入。
OrderDesc String False

排序方式。取值:

  • True:由小到大排序。
  • False:由大到小排序。
Length String 1000

每页显示的记录条数。用于分页查询,默认值:1000。

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

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

目前仅支持groupby(类似数据库的groupby语句)。

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

返回数据

名称 类型 示例值 描述
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

时间间隔。单位:秒。取值:60、300、900。

Message String The specified resource is not found.

错误信息。

示例

请求示例

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

正常返回示例

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. 未找到指定资源。

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