Queries the monitoring data in a namespace.
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).
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
cms:DescribeCustomMetricDataPoint | list | *All Resources * |
| 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 | long | Yes | The start of the time range to query. Unit: seconds. | 1653804865 |
End | long | 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 parameters
Examples
Sample success responses
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 |
409 | %s | Resources already exist. | - |
500 | InternalError | %s | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2022-05-30 | The Error code has changed | View Change Details |
2022-05-24 | Add Operation | View Change Details |