All Products
Search
Document Center

CloudMonitor:DescribeMetricMetaList

Last Updated:Jul 26, 2024

Queries the details of metrics that are supported in CloudMonitor.

Operation description

This operation is used together with DescribeMetricList and DescribeMetricLast. For more information, see DescribeMetricList and DescribeMetricLast .

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NamespacestringNo

The namespace of the cloud service.

For more information about the namespaces of cloud services, see Appendix 1: Metrics.

acs_kvstore
LabelsstringNo

The tags for filtering metrics. Specify a JSON string.

Format: [{"name":"tag key","value":"tag value"},{"name":"tag key","value":"tag value"}] . The following tags are available:

  • metricCategory: the category of the metric.
  • alertEnable: specifies whether to report alerts for the metric.
  • alertUnit: the unit of the metric in the alerts.
  • unitFactor: the factor for metric unit conversion.
  • minAlertPeriod: the minimum interval at which the alert is reported.
  • productCategory: the category of the service.
[{"name":"productCategory","value":"kvstore_old"}]
MetricNamestringNo

The metric name. For more information, see Appendix 1: Metrics.

CPUUtilization
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 30.

30

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The response code.

Note The status code 200 indicates that the request was successful.
200
Messagestring

The returned message.

The Request is not authorization.
RequestIdstring

The request ID.

0CCE0AF0-053C-4B13-A583-DC9A85785D49
TotalCountstring

The total number of entries returned.

12
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Resourcesarray<object>

The configuration of the metrics in the resources.

object
MetricNamestring

The metric name.

CPUUtilization
Descriptionstring

The metric description.

CPUUtilization
Labelsstring

The tags of the metric, including one or more JSON strings.

Format: [{"name":"tag key","value":"tag value"}]. The name can be repeated. The following tags are available:

  • metricCategory: the category of the metric.
  • alertEnable: indicates whether to report alerts for the metric.
  • alertUnit: the unit of the metric in the alerts.
  • unitFactor: the factor for metric unit conversion.
  • minAlertPeriod: the minimum interval at which the alert is reported.
  • productCategory: the category of the service.
[{\"name\":\"alertUnit\",\"value\":\"Bytes\"},{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"metricCategory\",\"value\":\"instanceId\"},{\"name\":\"instanceType\",\"value\":\"disaster\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"productCategory\",\"value\":\"kvstore_old\"}]
Unitstring

The unit of the metric.

%
Dimensionsstring

The monitoring dimensions of the resource. Multiple monitoring dimensions are separated with commas (,).

instanceId
Namespacestring

The namespace of the cloud service.

acs_kvstore
Periodsstring

The statistical periods of the metric. Multiple statistical periods are separated with commas (,).

Unit: seconds.

60,300
Statisticsstring

The statistical method. Multiple statistical methods are separated with commas (,).

Average,Minimum,Maximum

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "0CCE0AF0-053C-4B13-A583-DC9A85785D49",
  "TotalCount": "12",
  "Success": true,
  "Resources": {
    "Resource": [
      {
        "MetricName": "CPUUtilization",
        "Description": "CPUUtilization",
        "Labels": "[{\\\"name\\\":\\\"alertUnit\\\",\\\"value\\\":\\\"Bytes\\\"},{\\\"name\\\":\\\"minAlertPeriod\\\",\\\"value\\\":\\\"60\\\"},{\\\"name\\\":\\\"metricCategory\\\",\\\"value\\\":\\\"instanceId\\\"},{\\\"name\\\":\\\"instanceType\\\",\\\"value\\\":\\\"disaster\\\"},{\\\"name\\\":\\\"is_alarm\\\",\\\"value\\\":\\\"true\\\"},{\\\"name\\\":\\\"productCategory\\\",\\\"value\\\":\\\"kvstore_old\\\"}]",
        "Unit": "%",
        "Dimensions": "instanceId",
        "Namespace": "acs_kvstore",
        "Periods": "60,300",
        "Statistics": "Average,Minimum,Maximum"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.The specified resource is not found.
500InternalErrorThe request processing has failed due to some unknown error.-

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

Change history

Change timeSummary of changesOperation
2024-04-16API Description Update. The Error code has changedView Change Details