DescribeCustomMetricList - CloudMonitor - Alibaba Cloud Documentation Center

Queries the reported custom metrics of a cloud service.

Operation description

Note You can call the DescribeMetricList operation to query the metrics of a cloud service. 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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The ID of the application group. For more information, see DescribeMonitorGroups .	7378****
MetricName	string	No	The name of the custom metric.	cpu_total
Dimension	string	No	The dimensions that specify the resources for which you want to query custom metrics.	{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 custom metrics.	97c25982d9745a231276bff27469****
PageNumber	string	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	string	No	The number of entries to return on each 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 HTTP status code. Note The value 200 indicates that the call is successful.	200
Message	string	The returned message.	success
RequestId	string	The ID of the request.	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.