DescribeMetricData - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the monitoring metrics of a resource.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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_write_block_size disk_write_bps disk_write_iops	disk_bps_percent
StartTime	string	No	The beginning of the time range to query metric data. The start time can be up to 30 days before the current time. If you leave both the StartTime and EndTime parameters empty, the system queries the metrics for the most recent period. The time must be in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-11-21T01:50:00Z
EndTime	string	No	The end of the time range to query metric data. The time cannot be later than the current time. The time must be in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-11-21T02:00:00Z
Period	integer	No	The interval at which to query metric data. Unit: seconds. The default value is 5. Valid values: 5: 5-second precision. You can query data within a 12-hour time range. 10: 10-second precision. You can query data within a 24-hour time range. 60: 60-second precision. You can query data within a 7-day time range. 300: 300-second precision. You can query data within a 30-day time range. 600: 600-second precision. You can query data within a 30-day time range. 3600: 3600-second precision. You can query data within a 30-day time range.	60
Dimensions	string	No	A map of dimensions in the JSON format. The map specifies the dimensions to query. The following keys are supported: DiskId: The disk name, such as d-xxx. DeviceType: The disk category. `system` indicates a system disk and `data` indicates a data disk. DeviceCategory: The disk type, such as cloud_essd. EcsInstanceId: The name of the ECS instance to which the disk is attached, such as i-xxx. Azone: The zone, such as cn-hangzhou-a. The returned results are the intersection of all specified dimension-based filter conditions.	{"DiskId":["d-bp14xxxx","d-bp11xxxx"], "DeviceCategory": ["cloud_essd"]}
RegionId	string	No	The region ID.	cn-shanghai
AggreOps	string	No	The method for aggregating data over time. Valid values: SUM_OVER_TIME COUNT_OVER_TIME AVG_OVER_TIME MAX_OVER_TIME MIN_OVER_TIME SUM_OVER_TIME_LCRO: The sum of values in a left-closed, right-open interval. AVG_OVER_TIME_LCRO: The average of values in a left-closed, right-open interval. SUM_OVER_TIME_LORC: The sum of values in a left-open, right-closed interval. AVG_OVER_TIME_LORC: The average of values in a left-open, right-closed interval.	AVG_OVER_TIME
AggreOverLineOps	string	No	The method for aggregating data across different lines. Valid values: NON: No aggregation is performed. SUM: The sum of values. AVG: The average of values. COUNT: The number of values. MAX: The maximum value. MIN: The minimum value.	NON
GroupByLabels	array	No	A list of fields for grouping and aggregation.
	string	No	The field for grouping. The following fields are supported: DiskId: The disk name, such as d-xxx. DeviceType: The disk category. `system` indicates a system disk and `data` indicates a data disk. DeviceCategory: The disk type, such as cloud_essd. EcsInstanceId: The name of the ECS instance to which the disk is attached, such as i-xxx. Azone: The zone, such as cn-hangzhou-a.	DeviceType

Response parameters

Parameter	Type	Description	Example
	object	DescribeMetricDataResponse
TotalCount	integer	The total number of data entries returned.	1
DataList	array<object>	A collection of monitoring data for the disk.
	object	A list of returned data.
Labels	any	The labels.	{"DiskId": "d-1234"}
Datapoints	any	A list of monitoring data. The list contains a series of consecutive second-level timestamps and the corresponding metric values.	{"1699258861": 1,"1699259461": 0}
RequestId	string	The request ID.	11B55F58-D3A4-4A9B-9596-342420D0****
Warnings	array	A list of warning messages.
	string	The warning message.	not complete.

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "DataList": [
    {
      "Labels": "{\"DiskId\": \"d-1234\"}",
      "Datapoints": "{\"1699258861\": 1,\"1699259461\": 0}"
    }
  ],
  "RequestId": "11B55F58-D3A4-4A9B-9596-342420D0****",
  "Warnings": [
    "not complete."
  ]
}

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.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
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.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.
429	BLOCK.LimitedRequest	Request was denied due to user flow control.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.