Queries the monitoring data of a metric of a specified cloud service.

In this example, the cpu_idle metric of the acs_ecs_dashboard cloud service is queried. The result indicates the monitoring data of the cpu_idle metric for the i-abcdefgh12**** instance that belongs to the 120886317861**** Alibaba Cloud account. At a statistical period of 60 seconds, the maximum value is 100, the minimum value is 93.1, and the average value is 99.52.

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 DescribeMetricList

The operation that you want to perform. Set the value to DescribeMetricList.

MetricName String Yes cpu_idle

The name of the metric.

Note For more information, see Cloud service-specific metrics.
Namespace String Yes acs_ecs_dashboard

The namespace of the cloud service. Specify the value in the format of acs_Service name.

Note For more information, see Cloud service-specific metrics.
Period String No 60

The time interval at which metric data is queried. Unit: seconds. Valid values: 60, 300, and 900.

Note
StartTime String No 2019-01-30 00:00:00

The beginning of the time range to query. Supported formats:

  • UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970.
  • Time format: YYYY-MM-DDThh:mm:ssZ.
Note The specified period includes the start time and excludes the end time. The start time must be earlier than the end time.
EndTime String No 2019-01-30 00:10:00

The end of the time range to query. Supported formats:

  • UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970.
  • Time format: YYYY-MM-DDThh:mm:ssZ.
Dimensions String No [{"instanceId": "i-abcdefgh12****"}]

The dimensions. This parameter is used to specify the resources that you want to query.

Set the value to a collection of key-value pairs. A typical example is instanceId:i-2ze2d6j5uhg20x47****.

Note
NextToken String No 15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****

The paging token.

Note If this parameter is not specified, the data on the first page is returned. A return value other than Null of this parameter indicates that not all entries have been returned. You can use this value as an input parameter to obtain entries on the next page. The value Null indicates that all query results have been returned.
Length String No 1000

The number of entries to return on each page.

Express String No {"groupby":["userId","instanceId"]}

The expression that is used to compute the query results in real time.

Note Only the groupby expression is supported. This expression is similar to the GROUP BY statement that is used in databases.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String 3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42

The ID of the request.

Code String 200

The HTTP status code.

Note The value 200 indicates that the call was successful.
Success Boolean true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
NextToken String 15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****

The paging token.

Period String 60

The time interval at which metric data was queried. Unit: seconds. Valid values: 60, 300, and 900.

Datapoints String [{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]

The monitoring data.

Message String The specified resource is not found.

The error message.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeMetricList
&MetricName=cpu_idle
&Namespace=acs_ecs_dashboard
&<Common request parameters>

Sample success responses

XML format

<DescribeMetricListResponse>
	  <Period>60</Period>
	  <Datapoints>
		    <timestamp>1490152860000</timestamp>
		    <Maximum>100</Maximum>
		    <userId>120886317861****</userId>
		    <Minimum>93.1</Minimum>
		    <instanceId>i-abcdefgh12****</instanceId>
		    <Average>99.52</Average>
	  </Datapoints>
	  <RequestId>6A5F022D-AC7C-460E-94AE-B9E75083D027</RequestId>
	  <Success>true</Success>
	  <Code>200</Code>
</DescribeMetricListResponse>

JSON format

{
    "Period": "60",
    "Datapoints": [
        {
            "timestamp": 1490152860000,
            "Maximum": 100,
            "userId": "120886317861****",
            "Minimum": 93.1,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.52
        }
    ],
    "RequestId": "6A5F022D-AC7C-460E-94AE-B9E75083D027",
    "Success": true,
    "Code": "200"
}

Error codes

HttpCode Error code Error message Description
404 ResourceNotFound The specified resource is not found. The error message returned because the specified resource is not found.

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