调用DescribeMetricData查询指定云产品的某个监控项的监控数据

使用限制

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

使用说明

说明与DescribeMetricList不同，本接口具有统计功能（即Dimension={"instanceId": "i-abcdefgh12****"}），将该账号下的所有监控数据进行聚合统计。

本文将提供一个示例，查询云产品acs_ecs_dashboard监控项cpu_idle的监控数据。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeMetricData	要执行的操作，取值：DescribeMetricData。
Namespace	String	是	acs_ecs_dashboard	云产品的数据命名空间。关于云产品的数据命名空间，请参见云产品监控项。
MetricName	String	是	cpu_idle	云产品的监控项名称。关于云产品的监控项名称，请参见云产品监控项。
Period	String	否	60	监控项的统计周期。取值：15、60、900和3600。单位：秒。说明如果不设置统计周期，则按照注册监控项时申请的上报周期来查询监控数据。监控项（`MetricName`）的统计周期，请参见云产品监控项。
StartTime	String	否	1618368900000	查询监控数据的开始时间。当您未设置`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	否	1618368960000	查询监控数据的结束时间。当您未设置`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-abcdefgh12****"}]	维度Map，用于查询指定资源的监控数据。格式：key-value键值对形式的集合，常用的key-value集合为`instanceId:i-2ze2d6j5uhg20x47****`。说明单次请求最多支持批量查询50个实例。
Express	String	否	{"groupby":["userId","instanceId"]}	对查询出的现有结果进行实时计算的表达式。说明目前仅支持`groupby`（类似数据库`groupby`语句）。
Length	String	否	1000	每页显示的记录条数，用于分页查询。默认值：1000。说明单次请求Length的最大值为1440。

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

返回数据


名称	类型	示例值	描述
Code	String	200	状态码。说明 200表示成功。
Message	String	The specified resource is not found.	错误信息。
RequestId	String	6A5F022D-AC7C-460E-94AE-B9E75083D027	请求ID。
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。 `Minimum`、`Average`、`Maximum`：报警规则。
Period	String	60	监控数据的统计周期。取值：15、60、900和3600。单位：秒。

示例

请求示例

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

正常返回示例

XML格式

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

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

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