文档首页/ 云监控服务 CES/ API参考/ API/ 云资源监控/ 指标管理/ 查询主机监控维度指标信息
更新时间:2024-10-29 GMT+08:00
分享

查询主机监控维度指标信息

功能介绍

根据ECS/BMS资源ID查询磁盘、挂载点、进程、显卡、RAID控制器维度指标信息;维度NPU已经为原始值,不需要调用该接口进行额外查询获取指标信息

调试

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

URI

GET /v2/{project_id}/instances/{instance_id}/agent-dimensions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目编号。

最小长度:1

最大长度:64

instance_id

String

资源ID,如:4270ff17-aba3-4138-89fa-820594c39755。

最小长度:36

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

dim_name

String

维度名称,枚举类型,类型有: mount_point:挂载点, disk:磁盘, proc:进程, gpu:显卡, raid: RAID控制器,

枚举值:

  • mount_point

  • disk

  • proc

  • gpu

  • raid

dim_value

String

维度值,32位字符串,如:2e84018fc8b4484b94e89aae212fe615。

最小长度:32

最大长度:32

offset

Integer

分页偏移量

最小值:0

最大值:2147483647

缺省值:0

正则匹配:^(0|[1-9][0-9]*)$

limit

Integer

分页大小

最小值:1

最大值:1000

缺省值:1000

正则匹配:^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1000)$

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。默认使用application/json; charset=UTF-8。

缺省值:application/json; charset=UTF-8

最小长度:1

最大长度:64

X-Auth-Token

String

用户Token

最小长度:1

最大长度:16384

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

dimensions

Array of AgentDimension objects

维度信息

数组长度:0 - 2147483647

count

Integer

维度信息总数

最小值:0

最大值:2147483647

表5 AgentDimension

参数

参数类型

描述

name

String

维度名称,枚举类型,类型有: mount_point:挂载点, disk:磁盘, proc:进程, gpu:显卡, raid: RAID控制器

枚举值:

  • mount_point

  • disk

  • proc

  • gpu

  • raid

value

String

维度值,32位字符串,如:2e84018fc8b4484b94e89aae212fe615

最小长度:32

最大长度:32

origin_value

String

实际维度信息,字符串,如:vda。

最小长度:1

最大长度:1024

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:256

error_msg

String

错误信息

最小长度:0

最大长度:256

request_id

String

请求id

最小长度:0

最大长度:256

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:256

error_msg

String

错误信息

最小长度:0

最大长度:256

request_id

String

请求id

最小长度:0

最大长度:256

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:256

error_msg

String

错误信息

最小长度:0

最大长度:256

request_id

String

请求id

最小长度:0

最大长度:256

请求示例

查询资源ID为4270ff17-aba3-4138-89fa-820594c39755的主机监控维度指标信息。

/v2/{project_id}/instances/4270ff17-aba3-4138-89fa-820594c39755/agent-dimensions?offset=0&limit=10

响应示例

状态码: 200

查询成功

{
  "dimensions" : [ {
    "name" : "disk",
    "value" : "2e84018fc8b4484b94e89aae212fe615",
    "origin_value" : "vda"
  }, {
    "name" : "disk",
    "value" : "6a1b2de69eeb9a037ea23de6b529394d",
    "origin_value" : "vdc"
  } ],
  "count" : 10
}

状态码

状态码

描述

200

查询成功

400

参数校验失败

404

资源不存在

500

系统内部错误

错误码

请参见错误码

相关文档