DescribeHybridMonitorDataList - Cloud Monitor - Alibaba Cloud Documentation Center

Queries the monitoring data in a namespace.

Operation description

Prerequisites

Hybrid Cloud Monitoring is activated. For more information, see Activate Hybrid Cloud Monitoring.

Limits

The size of monitoring data that is returned in each call cannot exceed 1.5 MB. If the returned data reaches the upper limit, the query fails. You must reset the query conditions.

Operation description

This topic provides an example to show how to query the monitoring data of the AliyunEcs_cpu_total metric in the default-aliyun namespace from 1653804865 (14:14:25 on May 29, 2022) to 1653805225 (14:20:25 on May 29, 2022).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeCustomMetricDataPoint

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The name of the namespace. For more information about how to query the names of namespaces, see DescribeHybridMonitorNamespaceList.	default-aliyun
PromSQL	string	Yes	The metric name. Note PromQL statements are supported.	AliyunEcs_cpu_total
Start	integer	Yes	The start of the time range to query. Unit: seconds.	1653804865
End	integer	Yes	The end of the time range to query. Unit: seconds.	1653805225
Period	string	No	The statistical period of the monitoring data. Unit: seconds.	60

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

Response elements

Element	Type	Description	Example
	object	None.
Code	string	The response code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	end timestamp must not be before start time.
RequestId	string	The request ID.	C240412F-3F5F-50E2-ACEC-DE808EF9C4BE
Success	string	Indicates whether the request was successful. Valid values: true false	true
TimeSeries	array<object>	The returned monitoring data.
	array<object>
MetricName	string	The metric name.	AliyunEcs_cpu_total
Labels	array<object>	The tags of the time dimension.
	object
K	string	The tag key.	instanceId
V	string	The tag value.	i-rj99xc6cptkk64ml****
Values	array<object>	The metric values that are collected at different timestamps.
	object
V	string	The metric value.	0.13
Ts	string	The timestamp that indicates the time when the metric value is collected. Unit: seconds.	1653804865

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "end timestamp must not be before start time.",
  "RequestId": "C240412F-3F5F-50E2-ACEC-DE808EF9C4BE",
  "Success": "true",
  "TimeSeries": [
    {
      "MetricName": "AliyunEcs_cpu_total",
      "Labels": [
        {
          "K": "instanceId",
          "V": "i-rj99xc6cptkk64ml****"
        }
      ],
      "Values": [
        {
          "V": "0.13",
          "Ts": "1653804865"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	%s	%s
400	BadRequest	Bad request.	Error Parameter Request
500	InternalError	%s
403	%s	%s
404	%s	%s
409	%s	Resources already exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.