DescribeMetricMetaList - CloudMonitor - Alibaba Cloud Documentation Center

Queries the descriptions of time series metrics that are supported in Cloud Monitor.

Operation Description

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

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	No	The namespace of the service. For more information, see Appendix 1: Metrics.	acs_kvstore
Labels	string	No	The tags for filtering metrics. Specify a JSON string. Format:`[{"name":"tag name","value":"tag value"},{"name":"tag name","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 suggested unit of the metric value in alerts. unitFactor: the factor for metric unit conversion. minAlertPeriod: the minimum time interval to report a new alert. productCategory: the category of the service.	[{"name":"productCategory","value":"kvstore_old"}]
MetricName	string	No	The name of the metric. For more information, see Appendix 1: Metrics.	CPUUtilization
PageNumber	integer	No	The page to return. Default value: 1	1
PageSize	integer	No	The number of entries to return on each page. Default value: 30.	30

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The response code. Note The HTTP 200 code indicates that the request was successful.	200
Message	string	The error message.	The Request is not authorization.
RequestId	string	The ID of the request.	0CCE0AF0-053C-4B13-A583-DC9A85785D49
TotalCount	string	The total number of returned records.	12
Success	boolean	Indicates whether the request was successful. The value true indicates success. The value false indicates failure.	true
Resources	object []	The configuration of the metric.
MetricName	string	The name of the metric.	CPUUtilization
Description	string	The description of the metric.	CPUUtilization
Labels	string	The tags of the metric, including one or more JSON strings. Format: `[{"name":"tag name","value":"tag value"}]`. The `name` can be repeated. The following tags are available: metricCategory: the category of the metric. alertEnable: specifies whether to report alerts for the metric. alertUnit: the suggested unit of the metric value in alerts. unitFactor: the factor for metric unit conversion. minAlertPeriod: the minimum time interval to report a new alert. 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\"}]
Unit	string	The unit of the metric.	%
Dimensions	string	The dimensions of the metric. Multiple dimensions are separated with commas (,).	instanceId
Namespace	string	The namespace of the service. The value is usually in the format of acs_Service.	acs_kvstore
Periods	string	The statistical period of the metric. Multiple statistical periods are separated with commas (,).	60,300
Statistics	string	The statistical method. Multiple statistic 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 code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
500	InternalError	The request processing has failed due to some unknown error.	-

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