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

说明DescribeMetricList不同,本接口具有统计功能,即Dimension={"userId:"xxxx"},将该账号下的所有监控数据进行聚合统计。

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

调试

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

请求参数

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

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

MetricName String cpu_idle

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

Namespace String acs_ecs_dashboard

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

Period String 60

监控数据的统计周期。单位:秒。取值:15、60、900和3600。

说明 如果不设置统计周期,则按照注册监控项时申请的上报周期来查询监控数据。
StartTime String 1618368900000

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

  • 当您未设置StartTimeEndTime时,查询当前时间最近一个统计周期Period的监控数据。
  • 当您同时设置StartTimeEndTime时,查询指定时间段内距离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 1618368960000

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

  • 当您未设置StartTimeEndTime时,查询当前时间最近一个统计周期Period的监控数据。
  • 当您同时设置StartTimeEndTime时,查询指定时间段内距离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-abcdefgh12****"}]

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

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

说明 Dimensions传入时需要使用JSON字符串表示该Map对象,必须按顺序传入。
Express String {"groupby":["userId","instanceId"]}

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

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

Length String 1000

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

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

返回数据

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

状态码。

说明 200表示成功。
Datapoints String [{\"timestamp\":1618368900000,\"Average\":95.8291666666667,\"Minimum\":65.48,\"Maximum\":100.0},{\"timestamp\":1618368960000,\"Average\":95.8683333333333,\"Minimum\":67.84,\"Maximum\":100.0}]

监控数据列表。包括如下信息:

  • timestamp:发生报警的时间戳。
  • userId:发生报警的用户ID。
  • instanceId:发生报警的实例ID。
  • MinimumAverageMaximum:报警规则。
Message String The specified resource is not found.

错误信息。

Period String 60

监控数据的统计周期。单位:秒。取值:15、60、900和3600。

RequestId String 6A5F022D-AC7C-460E-94AE-B9E75083D027

请求ID。

示例

请求示例

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

正常返回示例

XML格式

<DescribeMetricDataResponse>
	  <RequestId>7598FEED-3B79-4B4A-AD01-435F34DA8EDC</RequestId>
	  <Period>60</Period>	
      <Datapoints>[{\"timestamp\":1618368900000,\"Average\":95.8291666666667,\"Minimum\":65.48,\"Maximum\":100.0},{\"timestamp\":1618368960000,\"Average\":95.8683333333333,\"Minimum\":67.84,\"Maximum\":100.0}]</Datapoints>
	  <Code>200</Code>
</DescribeMetricDataResponse>

JSON格式

{
	"RequestId": "7598FEED-3B79-4B4A-AD01-435F34DA8EDC",
	"Period": "60",
	"Datapoints": "[{\"timestamp\":1618368900000,\"Average\":95.8291666666667,\"Minimum\":65.48,\"Maximum\":100.0},{\"timestamp\":1618368960000,\"Average\":95.8683333333333,\"Minimum\":67.84,\"Maximum\":100.0}]",
	"Code": "200"
}

错误码

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

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