文档首页/ 云监控服务 CES/ API参考/ API/ 云资源监控/ 监控数据管理/ 查询监控数据 - ShowMetricData
更新时间：2026-01-20 GMT+08:00
查看PDF
分享

查询监控数据 - ShowMetricData

功能介绍

查询指定时间范围指定指标的指定粒度的监控数据，可以通过参数指定需要查询的数据维度。

接口约束

说明：

  • 对于dim字段的内容，可通过调用查询指标列表接口，在其响应体的相关指标数据中获取。

  • 对于OBS相关指标数据，当进行了相关OBS接口操作时可查询到相关指标数据，否则查询结果为空。

  • 对于EVS相关指标数据，disk_name维度下，它的返回值有云服务器实例ID-盘符名和云服务器实例ID-volume-卷ID两种。

    • 云服务器实例ID-盘符名，例如：6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d-vda(vda为盘符名)。

    • 云服务器实例ID-volume-卷ID，例如：6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d-volume-31f45764-38b3-44ad-aaca-4015c83371e6。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ces:metricData:get

    Read

    -

    -

    ces:metricData:list

    -

URI

GET /V1.0/{project_id}/metric-data

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符。

默认取值:

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

namespace

是

String

参数解释

服务命名空间，样例：弹性云服务器的命名空间为SYS.ECS。

各服务命名空间请参阅支持监控的服务列表约束限制

不涉及

取值范围

格式为service.item，service和item以点号拼接组成。

service和item必须以字母（大写或小写）开头，后面可以跟零个或多个字母（大写或小写）、数字、下划线（_），长度为[3,32]个字符

默认取值

不涉及

metric_name

是

String

参数解释

资源的监控指标名称，样例：弹性云服务器监控指标中的cpu_util。

各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档

约束限制

不涉及

取值范围

必须以字母（大写或小写）开头，后面可以跟零个或多个字母（大写或小写）、数字、下划线（_）、连字符 （-），长度为[1,96]个字符

默认取值

不涉及

dim.0

是

String

参数解释

指标的第一层维度，目前最多支持4个维度，维度格式为dim.{i}=key,value。样例：instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d

各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。

约束限制

不涉及

取值范围

dim.0=key,value，由key、value以逗号拼接组成。

key必须以字母（大写或小写）开头，后面可以跟零个或多个字母（大写或小写）、数字、下划线（）、连字符（-），长度为[1,32]个字符 value由多个字母（大写或小写）、数字、下划线（）、连字符（-）、点（.）、斜杠（/）、井号（#）、英文左括号（(）、英文右括号（)）组合而成，首个字符可以包含星号（*），但不能以连字符（-）开头，长度为[1,256]个字符

默认取值

不涉及

dim.1

否

String

参数解释

指标的第二层维度，目前最多支持4个维度，维度格式为dim.{i}=key,value。样例：instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d

各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。

约束限制

不涉及

取值范围

dim.1=key,value，由key、value以逗号拼接组成。

key必须以字母（大写或小写）开头，后面可以跟零个或多个字母（大写或小写）、数字、下划线（）、连字符（-），长度为[1,32]个字符 value由多个字母（大写或小写）、数字、下划线（）、连字符（-）、点（.）、斜杠（/）、井号（#）、英文左括号（(）、英文右括号（)）组合而成，首个字符可以包含星号（*），但不能以连字符（-）开头，长度为[1,256]个字符

默认取值

不涉及

dim.2

否

String

参数解释

指标的第三层维度，目前最多支持4个维度，维度格式为dim.{i}=key,value。样例：instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d

各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档

约束限制

不涉及

取值范围

dim.2=key,value，由key、value以逗号拼接组成。

key必须以字母（大写或小写）开头，后面可以跟零个或多个字母（大写或小写）、数字、下划线（）、连字符（-），长度为[1,32]个字符 value由多个字母（大写或小写）、数字、下划线（）、连字符（-）、点（.）、斜杠（/）、井号（#）、英文左括号（(）、英文右括号（)）组合而成，首个字符可以包含星号（*），但不能以连字符（-）开头，长度为[1,256]个字符

默认取值

不涉及

dim.3

否

String

参数解释

指标的第四层维度，目前最多支持4个维度，维度格式为dim.{i}=key,value。样例：instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d

各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档

约束限制

不涉及

取值范围

dim.3=key,value，由key、value以逗号拼接组成。

key必须以字母（大写或小写）开头，后面可以跟零个或多个字母（大写或小写）、数字、下划线（）、连字符（-），长度为[1,32]个字符 value由多个字母（大写或小写）、数字、下划线（）、连字符（-）、点（.）、斜杠（/）、井号（#）、英文左括号（(）、英文右括号（)）组合而成，首个字符可以包含星号（*），但不能以连字符（-）开头，长度为[1,256]个字符

默认取值

不涉及

filter

是

String

参数解释

聚合方式

约束限制

不涉及

取值范围

枚举值：

  • average 平均值

  • variance 方差

  • min 最小值

  • max 最大值

  • sum 求和值

默认取值

不涉及

period

是

Integer

参数解释

监控数据的聚合粒度，聚合解释可查看：“聚合含义”

约束限制

不涉及

取值范围

枚举值：

  • 1 监控资源的实时数据

  • 60 聚合1分钟粒度数据，表示1分钟一个数据点

  • 300 聚合5分钟粒度数据，表示5分钟一个数据点

  • 1200 聚合20分钟粒度数据，表示20分钟一个数据点

  • 3600 聚合1小时粒度数据，表示1小时一个数据点

  • 14400 聚合4小时粒度数据，表示4小时一个数据点

  • 86400 聚合1天粒度数据，表示1天一个数据点

默认取值

不涉及

from

是

Long

参数解释

查询数据起始时间，UNIX时间戳，单位毫秒。建议from的值相对于当前时间向前偏移至少1个周期。由于聚合运算的过程是将一个聚合周期范围内的数据点聚合到周期起始边界上，如果将from和to的范围设置在聚合周期内，会因为聚合未完成而造成查询数据为空，所以建议from参数相对于当前时间向前偏移至少1个周期。以5分钟聚合周期为例：假设当前时间点为10:35，10:30~10:35之间的原始数据会被聚合到10:30这个点上，所以查询5分钟数据点时from参数应为10:30或之前。云监控会根据所选择的聚合粒度向前取整from参数；如：1607146998177。

约束限制

不涉及

取值范围

毫秒级时间戳，范围为[1111111111111,9999999999999]

默认取值

不涉及

to

是

Long

参数解释

查询数据截止时间UNIX时间戳，单位毫秒

约束限制

from必须小于to

取值范围

毫秒级时间戳，范围为[1111111111111,9999999999999]

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符。

默认取值:

默认使用 application/json; charset=UTF-8，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

长度为[1,16384]个字符。

默认取值:

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

datapoints

Array of Datapoint objects

参数解释：

指标数据列表。由于查询数据时，云监控会根据所选择的聚合粒度向前取整from参数，所以datapoints中包含的数据点有可能会多于预期

metric_name

String

参数解释：

指标名称，例如弹性云服务器监控指标中的cpu_util。

取值范围：

不涉及
表5 Datapoint

参数

参数类型

描述

max

Double

参数解释

聚合周期内指标数据的最大值

取值范围

不涉及

min

Double

参数解释

聚合周期内指标数据的最小值

取值范围

不涉及

average

Double

参数解释

聚合周期内指标数据的平均值

取值范围

不涉及

sum

Double

参数解释

聚合周期内指标数据的求和值

取值范围

不涉及

variance

Double

参数解释

聚合周期内指标数据的方差

取值范围

不涉及

timestamp

Long

参数解释

指标采集时间，UNIX时间戳，单位毫秒

取值范围

不涉及

unit

String

参数解释

指标单位

取值范围

不涉及

状态码：400

表6 响应Body参数

参数

参数类型

描述

-

String

请求错误。

状态码：401

表7 响应Body参数

参数

参数类型

描述

-

String

未提供认证信息，或认证信息错误。

状态码：403

表8 响应Body参数

参数

参数类型

描述

-

String

请求页面被禁止访问。

状态码：408

表9 响应Body参数

参数

参数类型

描述

-

String

请求超出了服务器的等待时间。

状态码：429

表10 响应Body参数

参数

参数类型

描述

-

String

请求过多。

状态码：500

表11 响应Body参数

参数

参数类型

描述

-

String

请求未完成，服务异常。

状态码：503

表12 响应Body参数

参数

参数类型

描述

-

String

系统暂时不可用，请求受限。

请求示例

/V1.0/{project_id}/metric-data?namespace=SYS.ECS&metric_name=cpu_util&dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d&from=1442347449274&to=1442390649274&period=1200&filter=min

响应示例

状态码：200

OK

{
  "datapoints" : [ {
    "average" : 0,
    "timestamp" : 1442341200000,
    "unit" : "Count"
  } ],
  "metric_name" : "cpu_util"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

408

Request Timeout

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

错误码

请参见错误码。

父主题： 监控数据管理

相关文档