DescribeMetricMetaList - - Alibaba Cloud ドキュメントセンター

Queries the details of metrics that are supported in CloudMonitor.

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

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeMetricMetaList	The operation that you want to perform. Set the value to DescribeMetricMetaList.
Namespace	String	No	acs_kvstore	The namespace of the cloud service. For more information about the namespaces of cloud services, see Appendix 1: Metrics.
Labels	String	No	[{"name":"productCategory","value":"kvstore_old"}]	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 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.
MetricName	String	No	CPUUtilization	The metric name. For more information, see Appendix 1: Metrics.
PageNumber	Integer	No	1	The page number. Default value: 1.
PageSize	Integer	No	30	The number of entries per page. Default value: 30.

Response parameters


Parameter	Type	Example	Description
Code	String	200	The status code. Note The status code 200 indicates that the request was successful.
Message	String	The Request is not authorization.	The error message.
RequestId	String	CDE9EAFF-D54E-4024-BBFC-B0AAC883143B	The request ID.
TotalCount	String	10	The total number of entries returned.
Success	Boolean	true	Indicates whether the request was successful. Valid values: true false
Resources	Array of Resource		The configuration of the metrics in the resources.
Resource
MetricName	String	ads.diskSize	The metric name.
Description	String	The rated disk capacity	The metric description.
Labels	String	[{\"name\":\"minAlertPeriod\",\"value\":\"300\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Mbytes\"},{\"name\":\"productCategory\",\"value\":\"ads\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"workerId\"}]	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: 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.
Unit	String	MB	The unit of the metric.
Dimensions	String	userId,instanceId,tableSchema,workerId	The monitoring dimensions of the resource. Multiple monitoring dimensions are separated with commas (,).
Namespace	String	acs_ads	The namespace of the cloud service.
Periods	String	300	The statistical periods of the metric. Multiple statistical periods are separated with commas (,). Unit: seconds.
Statistics	String	Average,Minimum,Maximum	The statistical method. Multiple statistical methods are separated with commas (,).

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMetricMetaListResponse>
        <TotalCount>1853</TotalCount>
        <RequestId>CDE9EAFF-D54E-4024-BBFC-B0AAC883143B</RequestId>
        <Success>true</Success>
        <Code>200</Code>
        <Resources>
            <Resource>
                <Description>The rated disk capacity</Description>
                <Statistics>Average,Minimum,Maximum</Statistics>
                <MetricName>ads.diskSize</MetricName>
                <Labels>[{\"name\":\"minAlertPeriod\",\"value\":\"300\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Mbytes\"},{\"name\":\"productCategory\",\"value\":\"ads\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"workerId\"}]</Labels>
                <Dimensions>userId,instanceId,tableSchema,workerId</Dimensions>
                <Namespace>acs_ads</Namespace>
                <Periods>300</Periods>
                <Unit>MB</Unit>
            </Resource>
            <Resource>
                <Description>The used disk space</Description>
                <Statistics>Average,Minimum,Maximum</Statistics>
                <MetricName>ads.diskUsed</MetricName>
                <Labels>[{\"name\":\"alertUnit\",\"value\":\"Mbytes\"},{\"name\":\"minAlertPeriod\",\"value\":\"300\"},{\"name\":\"metricCategory\",\"value\":\"workerId\"},{\"name\":\"is_alarm\",\"value\":\"true\"}]</Labels>
                <Dimensions>userId,instanceId,tableSchema,workerId</Dimensions>
                <Namespace>acs_ads</Namespace>
                <Periods>300</Periods>
                <Unit>MB</Unit>
            </Resource>
            <Resource>
                <Description>The disk usage</Description>
                <Statistics>Average,Minimum,Maximum</Statistics>
                <MetricName>ads.diskUsedPercent</MetricName>
                <Labels>[{\"name\":\"alertUnit\",\"value\":\"%\"},{\"name\":\"minAlertPeriod\",\"value\":\"300\"},{\"name\":\"metricCategory\",\"value\":\"workerId\"},{\"name\":\"is_alarm\",\"value\":\"true\"}]</Labels>
                <Dimensions>userId,instanceId,tableSchema,workerId</Dimensions>
                <Namespace>acs_ads</Namespace>
                <Periods>300</Periods>
                <Unit>%</Unit>
            </Resource>
            <Resource>
                <Description>The number of unconsumed messages in the queue</Description>
                <Statistics>Maximum</Statistics>
                <MetricName>QueueMessageAccumulation</MetricName>
                <Labels>[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"count/min\"},{\"name\":\"productCategory\",\"value\":\"amqp\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"queue\"}]</Labels>
                <Dimensions>userId,regionId,vhostName,queueName</Dimensions>
                <Namespace>acs_amqp</Namespace>
                <Periods>60,300</Periods>
                <Unit>count/min</Unit>
            </Resource>
            <Resource>
                <Description>The number of new messages in the queue per minute</Description>
                <Statistics>Value</Statistics>
                <MetricName>QueueMessageInput</MetricName>
                <Labels>[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"n ame\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"count/min\"},{\"name\":\"productCategory\",\"value\":\"amqp\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"queue\"}]</Labels>
                <Dimensions>userId,regionId,vhostName,queueName</Dimensions>
                <Namespace>acs_amqp</Namespace>
                <Periods>60,300</Periods>
                <Unit>count/min</Unit>
            </Resource>
            <Resource>
                <Description>The number of unconsumed messages in the queue</Description>
                <Statistics>Value</Statistics>
                <MetricName>QueueMessageOutput</MetricName>
                <Labels>[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"count/min\"},{\"name\":\"productCategory\",\"value\":\"amqp\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"queue\"}]</Labels>
                <Dimensions>userId,regionId,vhostName,queueName</Dimensions>
                <Namespace>acs_amqp</Namespace>
                <Periods>60,300</Periods>
                <Unit>count/min</Unit>
            </Resource>
            <Resource>
                <Description>The number of messages generated by the instance per minute</Description>
                <Statistics>Value</Statistics>
                <MetricName>VhostMessageInput</MetricName>
                <Labels>[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"count/min\"},{\"name\":\"productCategory\",\"value\":\"amqp\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"vhost\"}]</Labels>
                <Dimensions>userId,regionId,vhostName</Dimensions>
                <Namespace>acs_amqp</Namespace>
                <Periods>60,300</Periods>
                <Unit>count/min</Unit>
            </Resource>
            <Resource>
                <Description>The number of messages consumed by the instance per minute</Description>
                <Statistics>Value</Statistics>
                <MetricName>VhostMessageOutput</MetricName>
                <Labels>[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"count/min\"},{\"name\":\"productCategory\",\"value\":\"amqp\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"vhost\"}]</Labels>
                <Dimensions>userId,regionId,vhostName</Dimensions>
                <Namespace>acs_amqp</Namespace>
                <Periods>60,300</Periods>
                <Unit>count/min</Unit>
            </Resource>
            <Resource>
                <Description></Description>
                <Statistics>Average</Statistics>
                <MetricName>Latency</MetricName>
                <Labels>[{\"name\":\"alertUnit\",\"value\":\"ms\"},{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"metricCategory\",\"value\":\"instanceId\"},{\"name\":\"is_alarm\",\"value\":\"true\"}]</Labels>
                <Dimensions>userId,region,apiUid</Dimensions>
                <Namespace>acs_apigateway_dashboard</Namespace>
                <Periods>60,300,900</Periods>
                <Unit>ms</Unit>
            </Resource>
            <Resource>
                <Description>The percentage of HTTP 4xx status codes in a specified time range</Description>
                <Statistics>Average,Minimum,Maximum</Statistics>
                <MetricName>code4xx</MetricName>
                <Labels>[{\"name\":\"alertUnit\",\"value\":\"%\"},{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"metricCategory\",\"value\":\"instanceId\"},{\"name\":\"is_alarm\",\"value\":\"true\"}]</Labels>
                <Dimensions>userId,instanceId</Dimensions>
                <Namespace>acs_cdn</Namespace>
                <Periods>60,300</Periods>
                <Unit>%</Unit>
            </Resource>
        </Resources>
</DescribeMetricMetaListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1853,
  "RequestId" : "CDE9EAFF-D54E-4024-BBFC-B0AAC883143B",
  "Success" : true,
  "Code" : 200,
  "Resources" : {
    "Resource" : [ {
      "Description" : "The rated disk capacity",
      "Statistics" : "Average,Minimum,Maximum",
      "MetricName" : "ads.diskSize",
      "Labels" : "[{\"name\":\"minAlertPeriod\",\"value\":\"300\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Mbytes\"},{\"name\":\"productCategory\",\"value\":\"ads\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"workerId\"}]",
      "Dimensions" : "userId,instanceId,tableSchema,workerId",
      "Namespace" : "acs_ads",
      "Periods" : "300",
      "Unit" : "MB"
    }, {
      "Description" : "The used disk space",
      "Statistics" : "Average,Minimum,Maximum",
      "MetricName" : "ads.diskUsed",
      "Labels" : "[{\"name\":\"alertUnit\",\"value\":\"Mbytes\"},{\"name\":\"minAlertPeriod\",\"value\":\"300\"},{\"name\":\"metricCategory\",\"value\":\"workerId\"},{\"name\":\"is_alarm\",\"value\":\"true\"}]",
      "Dimensions" : "userId,instanceId,tableSchema,workerId",
      "Namespace" : "acs_ads",
      "Periods" : "300",
      "Unit" : "MB"
    }, {
      "Description" : "The disk usage",
      "Statistics" : "Average,Minimum,Maximum",
      "MetricName" : "ads.diskUsedPercent",
      "Labels" : "[{\"name\":\"alertUnit\",\"value\":\"%\"},{\"name\":\"minAlertPeriod\",\"value\":\"300\"},{\"name\":\"metricCategory\",\"value\":\"workerId\"},{\"name\":\"is_alarm\",\"value\":\"true\"}]",
      "Dimensions" : "userId,instanceId,tableSchema,workerId",
      "Namespace" : "acs_ads",
      "Periods" : "300",
      "Unit" : "%"
    }, {
      "Description" : "The number of unconsumed messages in the queue",
      "Statistics" : "Maximum",
      "MetricName" : "QueueMessageAccumulation",
      "Labels" : "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"count/min\"},{\"name\":\"productCategory\",\"value\":\"amqp\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"queue\"}]",
      "Dimensions" : "userId,regionId,vhostName,queueName",
      "Namespace" : "acs_amqp",
      "Periods" : "60,300",
      "Unit" : "count/min"
    }, {
      "Description" : "The number of new messages in the queue per minute",
      "Statistics" : "Value",
      "MetricName" : "QueueMessageInput",
      "Labels" : "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"n ame\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"count/min\"},{\"name\":\"productCategory\",\"value\":\"amqp\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"queue\"}]",
      "Dimensions" : "userId,regionId,vhostName,queueName",
      "Namespace" : "acs_amqp",
      "Periods" : "60,300",
      "Unit" : "count/min"
    }, {
      "Description" : "The number of unconsumed messages in the queue",
      "Statistics" : "Value",
      "MetricName" : "QueueMessageOutput",
      "Labels" : "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"count/min\"},{\"name\":\"productCategory\",\"value\":\"amqp\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"queue\"}]",
      "Dimensions" : "userId,regionId,vhostName,queueName",
      "Namespace" : "acs_amqp",
      "Periods" : "60,300",
      "Unit" : "count/min"
    }, {
      "Description" :"The number of messages generated by the instance per minute",
      "Statistics" : "Value",
      "MetricName" : "VhostMessageInput",
      "Labels" : "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"count/min\"},{\"name\":\"productCategory\",\"value\":\"amqp\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"vhost\"}]",
      "Dimensions" : "userId,regionId,vhostName",
      "Namespace" : "acs_amqp",
      "Periods" : "60,300",
      "Unit" : "count/min"
    }, {
      "Description" : "The number of messages consumed by the instance per minute",
      "Statistics" : "Value",
      "MetricName" : "VhostMessageOutput",
      "Labels" : "[{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"count/min\"},{\"name\":\"productCategory\",\"value\":\"amqp\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"vhost\"}]",
      "Dimensions" : "userId,regionId,vhostName",
      "Namespace" : "acs_amqp",
      "Periods" : "60,300",
      "Unit" : "count/min"
    }, {
      "Description" : "",
      "Statistics" : "Average",
      "MetricName" : "Latency",
      "Labels" : "[{\"name\":\"alertUnit\",\"value\":\"ms\"},{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"metricCategory\",\"value\":\"instanceId\"},{\"name\":\"is_alarm\",\"value\":\"true\"}]",
      "Dimensions" : "userId,region,apiUid",
      "Namespace" : "acs_apigateway_dashboard",
      "Periods" : "60,300,900",
      "Unit" : "ms"
    }, {
      "Description" : "The percentage of HTTP 4xx status codes in a specified time range",
      "Statistics" : "Average,Minimum,Maximum",
      "MetricName" : "code4xx",
      "Labels" : "[{\"name\":\"alertUnit\",\"value\":\"%\"},{\"name\":\"minAlertPeriod\",\"value\":\"60\"},{\"name\":\"metricCategory\",\"value\":\"instanceId\"},{\"name\":\"is_alarm\",\"value\":\"true\"}]",
      "Dimensions" : "userId,instanceId",
      "Namespace" : "acs_cdn",
      "Periods" : "60,300",
      "Unit" : "%"
    } ]
  }
}

Error codes


HTTP status code	Error code	Error message	Description
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

For a list of error codes, see Service error codes.