DescribeMetricData - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the statistics about a metric of Elastic Block Storage (EBS) disks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ebs:DescribeMetricData	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
MetricName	string	Yes	The name of the metric. Valid values: disk_bps_percent disk_iops_percent disk_read_block_size disk_read_bps disk_read_iops disk_read_latency disk_write_block_size disk_write_bps disk_write_iops disk_write_latency	disk_bps_percent
StartTime	string	No	The beginning of the time range to query. You can specify a point in time that is up to one year apart from the current time. If StartTime and EndTime are both unspecified, the monitoring metric data of the last Period value is queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-11-21T01:50:00Z
EndTime	string	No	The end of the time range to query. The specified time must be later than the current time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-11-21T02:00:00Z
Period	integer	No	The interval at which metric data is collected. Unit: seconds. Default value: 60. Valid values: 60, 300, 600, and 3600, which support queries for time ranges of up to 2 hours, 2 hours, 1 day, and 7 days, respectively. For example, if you set Period to 60, the end time is less than 2 hours from the end time.	60
Dimensions	string	No	The dimension map in the JSON format. A dimension is a key-value pair. Valid dimension key: diskId.	{"diskId":["d-bp14xxxx","d-bp11xxxx"]}
RegionId	string	No	The region ID.	cn-shanghai
AggreOps	string	No	Aggregation method in time dimension. Valid values: SUM COUNT AVG MAX MIN	SUM

Response parameters

Parameter	Type	Description	Example
	object	Schema of response.
TotalCount	integer	The total number of data entries queried.	3
DataList	array<object>	The disk monitoring data.
metricData	object
Labels	any	The tags.	{"DiskId": "d-1234"}
Datapoints	any	The datapoints that consist of consecutive timestamps in seconds and metric values that were recorded at these time points.	{ "1699258861": 1, "1699259461": 0, "1699260061": 0, "1699260661": 0, "1699261261": 0, "1699261861": 0, "1699262461": 0, "1699263061": 0, "1699263661": 0, "1699264261": 0, "1699264861": 0 }
RequestId	string	The request ID.	11B55F58-D3A4-4A9B-9596-342420D0****

Examples

Sample success responses

JSONformat

{
  "TotalCount": 3,
  "DataList": [
    {
      "Labels": "{\"DiskId\": \"d-1234\"}",
      "Datapoints": "{\n        \"1699258861\": 1,\n        \"1699259461\": 0,\n        \"1699260061\": 0,\n        \"1699260661\": 0,\n        \"1699261261\": 0,\n        \"1699261861\": 0,\n        \"1699262461\": 0,\n        \"1699263061\": 0,\n        \"1699263661\": 0,\n        \"1699264261\": 0,\n        \"1699264861\": 0\n}"
    }
  ],
  "RequestId": "11B55F58-D3A4-4A9B-9596-342420D0****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter %s is invalid.	The specified parameter value is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.	-
400	InvalidParameter.Format	Specified parameter format is not valid.	english description
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	The parameter must be specified.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.	-
403	LastTokenProcessing	The last token request is processing.	The value of clientToken is used in another request that is being processed. Try again later.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.	You are not authorized to create service-linked roles.
403	OperationDenied	The operation is not allowed.	The operation is not supported.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.	-
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
429	BLOCK.LimitedRequest	Request was denied due to user flow control.	-
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-11-07	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-01-03	The Error code has changed	View Change Details