DescribeCustomMetricList - CloudMonitor - Alibaba Cloud Documentation Center

Queries the reported monitoring data.

Operation description

Note You can call the DescribeMetricList operation to query the metrics of cloud services. For more information, see DescribeMetricList .

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
cms:DescribeCustomMetricList	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The ID of the application group. For information about how to query the IDs of application groups, see DescribeMonitorGroups .	7378****
MetricName	string	No	The name of the custom metric.	cpu_total
Dimension	string	No	The dimensions based on which the resources are queried.	{sampleName1=value1&sampleName2=value2}
Md5	string	No	The MD5 value of the HTTP request body. The MD5 value is a 128-bit hash value used to verify the uniqueness of the reported monitoring data.	97c25982d9745a231276bff27469****
PageNumber	string	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	string	No	The number of entries per page. Pages start from page 1. Default value: 10.	10

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The responses code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	success
RequestId	string	The request ID.	1AF425E4-1DEA-54F2-910A-8117C9686140
Result	string	The reported custom metrics that are found in the query.	{\"all\":0,\"size\":10,\"param\":{\"metric\":\"{\\\"metricName\\\":\\\"cpu_total\\\",\\\"groupId\\\":7378**,\\\"project\\\":\\\"acs_customMetric_120886317861**\\\",\\\"dimension\\\":\\\"sampleName1=value1&sampleName2=value2\\\",\\\"status\\\":1}\",\"service\":\"metric-center.aliyun-inc.com\"},\"page\":1,\"list\":[]}

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "success",
  "RequestId": "1AF425E4-1DEA-54F2-910A-8117C9686140",
  "Result": "{\\\"all\\\":0,\\\"size\\\":10,\\\"param\\\":{\\\"metric\\\":\\\"{\\\\\\\"metricName\\\\\\\":\\\\\\\"cpu_total\\\\\\\",\\\\\\\"groupId\\\\\\\":7378****,\\\\\\\"project\\\\\\\":\\\\\\\"acs_customMetric_120886317861****\\\\\\\",\\\\\\\"dimension\\\\\\\":\\\\\\\"sampleName1=value1&sampleName2=value2\\\\\\\",\\\\\\\"status\\\\\\\":1}\\\",\\\"service\\\":\\\"metric-center.aliyun-inc.com\\\"},\\\"page\\\":1,\\\"list\\\":[]}"
}

Error codes

HTTP status code	Error code	Error message
400	%s	%s
500	InternalError	The request processing has failed due to some unknown error.

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

Change history

Change time	Summary of changes	Operation

No change history