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

本文将提供一个示例,查询云服务acs_ecs_dashboard的监控项cpu_idle的监控数据。返回结果显示,当前账号100931896542****下实例i-2ze5xhf87nzvhcxr****间隔60秒的最大值为100、最小值为95.47、平均值为98.35。

调试

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

请求参数

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

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

MetricName String cpu_idle

监控项名称。

说明 关于监控项名称,请参见 云服务监控项
Namespace String acs_ecs_dashboard

云服务的数据命名空间。命名方式:acs_云服务名称。

说明 关于云服务的命名空间,请参见 云服务监控项
Period String 60

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

说明
  • 请根据您的实际需求设置该参数。
  • 关于云服务的时间间隔,请参见云服务监控项
StartTime String 1618368900000

开始时间。支持的格式:

  • Unix时间戳:从1970年1月1日开始所经过的毫秒数。
  • Format格式:YYYY-MM-DDThh:mm:ssZ。
说明
  • 开始和结束时间执行的是左开右闭的模式,StartTime不能等于或大于EndTime
  • 建议您使用Unix时间戳,避免时区问题。
EndTime String 1618368960000

结束时间。支持的格式:

  • 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对象,必须按顺序传入。
  • 关于云服务的维度,请参见云服务监控项
NextToken String IWBjqMYSy0is7zSMGu16****

当请求的返回结果被截断时,您可以使用NextToken再次发起请求,获取从当前截断位置之后的内容。

Length String 1000

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

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

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

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

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

返回数据

名称 类型 示例值 描述
RequestId String E68C1F4B-0CBC-4A0B-BCB5-212431FB817E

请求ID。

Code String 200

状态码。

说明 200表示成功。
Success Boolean true

操作是否成功。取值:

  • true:成功。
  • false:失败。
NextToken String IWBjqMYSy0is7zSMGu16****

查询下一页使用的Token。

Period String 60

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

Datapoints String [{\"timestamp\":1625328060000,\"userId\":\"100931896542****\",\"instanceId\":\"i-2ze5xhf87nzvhcxr****\",\"Average\":98.35,\"Minimum\":95.47,\"Maximum\":100.0},{\"timestamp\":1625328060000,\"userId\":\"100931896542****\",\"instanceId\":\"i-bp1ayw2n047u2wkl****\",\"Average\":96.49,\"Minimum\":50.0,\"Maximum\":100.0}]

监控数据列表。

Message String The specified resource is not found.

错误信息。

示例

请求示例

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

正常返回示例

XML格式

<DescribeMetricListResponse>
	  <RequestId>E68C1F4B-0CBC-4A0B-BCB5-212431FB817E</RequestId>
	  <Period>60</Period>
	  <Datapoints>[{\"timestamp\":1625328060000,\"userId\":\"100931896542****\",\"instanceId\":\"i-2ze5xhf87nzvhcxr****\",\"Average\":98.35,\"Minimum\":95.47,\"Maximum\":100.0},{\"timestamp\":1625328060000,\"userId\":\"100931896542****\",\"instanceId\":\"i-bp1ayw2n047u2wkl****\",\"Average\":96.49,\"Minimum\":50.0,\"Maximum\":100.0}]</Datapoints>
	  <Code>200</Code>
	  <Success>true</Success>
</DescribeMetricListResponse>

JSON格式

{
	"RequestId": "E68C1F4B-0CBC-4A0B-BCB5-212431FB817E",
	"Period": "60",
	"Datapoints": "[{\"timestamp\":1625328060000,\"userId\":\"100931896542****\",\"instanceId\":\"i-2ze5xhf87nzvhcxr****\",\"Average\":98.35,\"Minimum\":95.47,\"Maximum\":100.0},{\"timestamp\":1625328060000,\"userId\":\"100931896542****\",\"instanceId\":\"i-bp1ayw2n047u2wkl****\",\"Average\":96.49,\"Minimum\":50.0,\"Maximum\":100.0}]",
	"Code": "200",
	"Success": true
}

错误码

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

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