Queries the reported custom metrics of a cloud service.

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCustomMetricList

The operation that you want to perform. Set the value to DescribeCustomMetricList.

GroupId String No 7378****

The ID of the application group.

For more information, see DescribeMonitorGroups.

MetricName String No cpu_total

The name of the custom metric.

Dimension String No {sampleName1=value1&sampleName2=value2}

The dimensions that specify the resources for which you want to query custom metrics.

Md5 String No 97c25982d9745a231276bff27469****

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.

PageNumber String No 1

The number of the page to return.

Pages start from page 1. Default value: 1.

PageSize String No 10

The number of entries to return on each page.

Pages start from page 1. Default value: 10.

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

Response parameters

Parameter Type Example Description
RequestId String 1AF425E4-1DEA-54F2-910A-8117C9686140

The ID of the request.

Code String 200

The HTTP status code.

Note The value 200 indicates that the call is successful.
Result String {\"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\":[]}

The reported custom metrics that are found in the query.

Message String success

The returned message.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCustomMetricList
&<Common request parameters>

Sample success responses

XML format 

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

JSON format 

{
    "Message": "success",
    "RequestId": "1AF425E4-1DEA-54F2-910A-8117C9686140",
    "Code": "200",
    "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

For a list of error codes, visit the API Error Center.