文档首页/ 云监控服务 CES/ API参考/ API/ 云资源监控/ 指标管理/ 查询主机监控原始维度值 - ListAgentDimensionInfo
更新时间：2025-10-29 GMT+08:00
查看PDF
分享

查询主机监控原始维度值 - ListAgentDimensionInfo

功能介绍

根据ECS/BMS资源ID及特殊维度值(仅支持磁盘、挂载点、进程、显卡、RAID控制器)查询该特殊维度对应的原始维度值；其他维度无需调用该接口

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ces:namespacesDimensions:listAgentDimensions

    List

    -

    -
    • ces:namespacesDimensions:list

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

instance_id

是

String

参数描述：

资源ID，如：4270ff17-aba3-4138-89fa-820594c39755。

约束限制：

不涉及。

取值范围：

字符串长度为36。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

dim_name

是

String

参数描述：

维度名称。

约束限制：

不涉及。

取值范围：

枚举类型，mount_point:挂载点，disk:磁盘，proc:进程，gpu:显卡，raid:RAID控制器。

默认取值：

不涉及。

dim_value

否

String

参数描述：

维度值(建议：同一个instance_id下相同dim_value对应的原始维度值origin_value是一样的，无需多次调用，建议根据instance_id + dim_value作为key进行缓存重复使用)。

约束限制：

不涉及。

取值范围：

32位字符串，如：2e84018fc8b4484b94e89aae212fe615。

默认取值：

不涉及。

offset

否

Integer

参数描述：

分页偏移量。

约束限制：

不涉及。

取值范围：

最小值为0，最大值为2147483647。

默认取值：

0

limit

否

Integer

参数描述：

分页大小。

约束限制：

不涉及。

取值范围：

最小值为1，最大值为1000。

默认取值：

1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为64。

默认取值:

默认使用application/json; charset=UTF-8。

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为16384。

默认取值:

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

dimensions

Array of AgentDimension objects

参数解释：

维度信息。

count

Integer

参数解释：

维度信息总数。

取值范围：

整数，最小值为0，最大值为2147483647。
表5 AgentDimension

参数

参数类型

描述

name

String

参数解释：

维度名称。

取值范围：

枚举类型，mount_point:挂载点，disk:磁盘，proc:进程，gpu:显卡，raid:RAID控制器。

value

String

参数解释：

维度值。

取值范围：

字符串长度为32。

origin_value

String

参数解释：

实际维度信息。

取值范围

字符串长度在 1 到 1024 之间。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

请求示例

/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

系统内部错误

错误码

请参见错误码。

父主题： 指标管理

相关文档