更新时间:2024-05-09 GMT+08:00
分享

获取资源监控数据

功能介绍

获取资源监控数据

URI

GET /v1/{project_id}/metric-data

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

华为云项目ID,您可以从获取项目ID中获取。

最小长度:1

最大长度:128

表2 Query参数

参数

是否必选

参数类型

描述

from_time

Long

查询监控数据起始时间,UNIX时间戳,单位毫秒,不填时默认为当前时间

to_time

Long

查询数据截止时间,UNIX时间戳,单位毫秒,不填时默认为当前时间

period

String

监控数据周期。枚举值,取值范围:real_time(实时数据)、five_minutes(5分钟粒度)、fifteen_to_twenty_minutes(15-20分钟粒度)、one_hour(1小时粒度),不填时默认为real_time

缺省值:real_time

method

String

统计方法。枚举值,取值范围:max(最大值)、min(最小值)、average(平均值),不填时默认为max

缺省值:max

metric_name

String

查询的监控指标名称

resource_id

String

查询的监控资源对象id,当查询存储资源和计算节点资源中的集群监控数据时,不需要填写资源id

最小长度:1

最大长度:128

device_id

String

显卡id,仅查询裸金属节点的gpu监控时,需要指定

最小长度:1

最大长度:128

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data_points

Array of DataPointDto objects

监控数据列表

metric_name

String

监控指标名称

resource_id

String

监控资源id

表5 DataPointDto

参数

参数类型

描述

timestamp

Long

时间戳

unit

String

数据单位

value

Number

统计结果

请求示例

获取资源监控数据

https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/metric-data

响应示例

状态码: 200

OK

{
  "data_points" : [ {
    "timestamp" : 1467892800000,
    "unit" : "bytes/second",
    "value" : 33.2
  } ],
  "metric_name" : "read_bandwidth",
  "resource_id" : 123456789
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档