DescribeMetricMetaList - CloudMonitor - Alibaba Cloud Documentation Center

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.

Debug

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 cloud service. For more information about the namespaces of cloud services, see Appendix 1: Metrics.	acs_kvstore
Labels	string	No	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"}]
MetricName	string	No	The metric name. For more information, see Appendix 1: Metrics.	CPUUtilization
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 30.	30

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The response code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	The Request is not authorization.
RequestId	string	The request ID.	0CCE0AF0-053C-4B13-A583-DC9A85785D49
TotalCount	string	The total number of entries returned.	12
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Resources	array<object>	The configuration of the metrics in the resources.
	object
MetricName	string	The metric name.	CPUUtilization
Description	string	The metric description.	CPUUtilization
Labels	string	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\"}]
Unit	string	The unit of the metric.	%
Dimensions	string	The monitoring dimensions of the resource. Multiple monitoring dimensions are separated with commas (,).	instanceId
Namespace	string	The namespace of the cloud service.	acs_kvstore
Periods	string	The statistical periods of the metric. Multiple statistical periods are separated with commas (,). Unit: seconds.	60,300
Statistics	string	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 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.

Change history

Change time	Summary of changes	Operation
2024-04-16	API Description Update. The Error code has changed	View Change Details