Queries the reported monitoring data.

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 Yes 12345

The ID of the application group.
MetricName String No Availability

The name of the metric. Valid values:

  • Availability
  • ResponseTime
Dimension String No [{"instanceId":"XXXXXX"}]

The dimensions that specify the resources for which you want to query monitoring data.

Set the value to a collection of key-value pairs. A typical key-value pair is instanceId:XXXXXX.

The key and value must be 1 to 64 bytes in length, respectively. Excessive bytes are truncated from the string.

The key and value can contain letters, digits, periods (.), hyphens (-), underscores (_), forward slashes (/), and backslashes (\).

Note Dimensions must be organized in a JSON string and follow the required order.
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 monitoring data.

PageNumber String No 1

The number of the page to return.
PageSize String No 10

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
RequestId String 1C225028-B13B-4EFE-AE34-75C5F7412FB2

The ID of the request.
Code String 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Result String {"param":{"metric":"{\"project\":\"acs_customMetric_12345\",\"status\":1}","service":"metrics.xxxxx.com"},"data":[{"groupId":"111","count":1},{"groupId":"111","count":2}]}

The reported monitoring data that was queried.
Message String success

The returned message.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeCustomMetricList>
          <Result>{"param":{"metric":"{\"project\":\"acs_customMetric_12345\",\"status\":1}","service":"metrics.xxxxx.com"},"data":[{"groupId":"111","count":1},{"groupId":"111","count":2}]}</Result>
          <Message>success</Message>
          <RequestId>1C225028-B13B-4EFE-AE34-75C5F7412FB2</RequestId>
          <Code>200</Code>
</DescribeCustomMetricList>

JSON format 

{
    "Result":"{\"param\":{\"metric\":\"{\\\"project\\\":\\\"acs_customMetric_12345\\\",\\\"status\\\":1}\",\"service\":\"metrics.xxxxx.com\"},\"data\":[{\"groupId\":\"111\",\"count\":1},{\"groupId\":\"111\",\"count\":2}]}",
    "Message":"success",
    "RequestId":"1C225028-B13B-4EFE-AE34-75C5F7412FB2",
    "Code":"200"
}

Error codes

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