All Products
Search
Document Center

CloudMonitor:DescribeHybridMonitorDataList

Last Updated:Jul 26, 2024

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.

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NamespacestringYes

The name of the namespace.

For more information about how to query the names of namespaces, see DescribeHybridMonitorNamespaceList .

default-aliyun
PromSQLstringYes

The metric name.

Note PromQL statements are supported.
AliyunEcs_cpu_total
StartlongYes

The start of the time range to query.

Unit: seconds.

1653804865
EndlongYes

The end of the time range to query.

Unit: seconds.

1653805225
PeriodstringNo

The statistical period of the monitoring data.

Unit: seconds.

60

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

Response parameters

ParameterTypeDescriptionExample
object

None.

Codestring

The response code.

Note The status code 200 indicates that the request was successful.
200
Messagestring

The returned message.

end timestamp must not be before start time.
RequestIdstring

The request ID.

C240412F-3F5F-50E2-ACEC-DE808EF9C4BE
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true
TimeSeriesarray<object>

The returned monitoring data.

object
MetricNamestring

The metric name.

AliyunEcs_cpu_total
Labelsarray<object>

The tags of the time dimension.

object
Kstring

The tag key.

instanceId
Vstring

The tag value.

i-rj99xc6cptkk64ml****
Valuesarray<object>

The metric values that are collected at different timestamps.

object
Vstring

The metric value.

0.13
Tsstring

The timestamp that indicates the time when the metric value is collected.

Unit: seconds.

1653804865

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400%s%s
400BadRequest%s
409%sResources already exist.
500InternalError%s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-05-30The Error code has changedView Change Details
2022-05-24Add OperationView Change Details