调用DescribeMetricList接口查询指定云产品的指定监控项的监控数据。

使用限制

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

使用说明

本文将提供一个示例,查询云产品acs_ecs_dashboard的监控项cpu_idle的监控数据。返回结果显示,当前账号120886317861****下实例i-abcdefgh12****间隔60秒的最大值为100、最小值为93.1、平均值为99.52。

调试

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

请求参数

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

要执行的操作,取值:DescribeMetricList

Namespace String acs_ecs_dashboard

云产品的数据命名空间。命名方式:acs_云产品名称。

关于云产品的数据命名空间,请参见云产品监控项

MetricName String cpu_idle

监控项名称。

关于监控项名称,请参见云产品监控项

Period String 60

时间间隔。

取值:60、300、900。

单位:秒。

说明 请根据您的实际需求设置该参数。
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。
Dimensions String [{"instanceId": "i-abcdefgh12****"}]

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

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

说明 单次请求最多支持批量查询50个实例。
NextToken String 15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****

分页游标标识。

说明 如果不设置该参数,则表示获取第一页的数据。当该参数有返回值时,说明还有下一页,您可以将返回的NextToken作为参数再次请求获得下一页的数据,直到返回为Null为止,表示获取到了所有的数据。
Length String 1000

每页显示的记录条数,用于分页查询。

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

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

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

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

返回数据

名称 类型 示例值 描述
NextToken String 15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****

分页游标标识。

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

请求ID。

Success Boolean true

操作是否成功。取值:

  • true:成功。
  • false:失败。
Datapoints String [{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]

监控数据列表。

Code String 200

状态码。

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

错误信息。

Period String 60

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

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMetricListResponse>
	<Period>60</Period>
	<Datapoints>
		<timestamp>1490152860000</timestamp>
		<Maximum>100</Maximum>
		<userId>120886317861****</userId>
		<Minimum>93.1</Minimum>
		<instanceId>i-abcdefgh12****</instanceId>
		<Average>99.52</Average>
	</Datapoints>
	<RequestId>6A5F022D-AC7C-460E-94AE-B9E75083D027</RequestId>
	<Success>true</Success>
	<Code>200</Code>
</DescribeMetricListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Period" : "60",
  "Datapoints" : [ {
    "timestamp" : 1490152860000,
    "Maximum" : 100,
    "userId" : "120886317861****",
    "Minimum" : 93.1,
    "instanceId" : "i-abcdefgh12****",
    "Average" : 99.52
  } ],
  "RequestId" : "6A5F022D-AC7C-460E-94AE-B9E75083D027",
  "Success" : true,
  "Code" : "200"
}

错误码

HttpCode 错误码 错误信息 描述
404 ResourceNotFound The specified resource is not found. 未找到指定资源。

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