文档首页/ 分布式缓存服务 DCS/ API参考/ API V2（推荐）/ 其他接口/ 查询主维度信息列表 - ListMonitoredObjects
更新时间：2025-10-23 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询主维度信息列表 - ListMonitoredObjects

功能介绍

查询主维度对象列表，主维度ID当前支持dcs_instance_id，dcs_memcached_instance_id。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    dcs:instance:list

    List

    -

    g:EnterpriseProjectId

    -

    -

URI

GET /v2/{project_id}/dims/monitored-objects

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

dim_name

是

String

参数解释：

主维度ID。

约束限制：

不涉及。

取值范围：

当前支持dcs_instance_id，dcs_memcached_instance_id。

默认取值：

不涉及。

offset

否

Integer

参数解释：

偏移量，表示生成的列表从此偏移量开始显示，例如偏移量为3时，生成的列表从第4条开始。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

否

Integer

参数解释：

每页显示的条目数量。

约束限制：

不涉及。

取值范围：

1-1000

默认取值：

10

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

router

Array of strings

参数解释：

当前查询维度路由。如果是主维度，则数组中是自身ID。

取值范围：

不涉及。

children

Array of DimChild objects

参数解释：

当前查询维度子维度对象列表。当前只有维度为dcs_instance_id时才有值。

取值范围：

  • Proxy集群有两个子维度，分别为：dcs_cluster_redis_node和dcs_cluster_proxy_node。

  • Cluster集群有一个子维度：dcs_cluster_proxy_node。

instances

Array of InstancesMonitoredObject objects

参数解释：

当前查询维度监控对象列表。

取值范围：

不涉及。

total

Integer

参数解释：

主维度监控对象的总数。

取值范围：

不涉及。
表4 DimChild

参数

参数类型

描述

dim_name

String

参数解释：

维度名称。

取值范围：

  • dcs_instance_id：Redis实例

  • dcs_cluster_redis_node：数据节点

  • dcs_cluster_proxy_node/dcs_cluster_proxy2_node：Proxy节点

  • dcs_memcached_instance_id

dim_route

String

参数解释：

维度的路由，结构为主维度名称，当前维度名称，例如：

dim_name字段为dcs_cluster_redis_node时，这个字段的值为dcs_instance_id，dcs_cluster_redis_node。

取值范围：

不涉及。
表5 InstancesMonitoredObject

参数

参数类型

描述

dcs_instance_id

String

参数解释：

测量对象ID，即实例的ID。

取值范围：

不涉及。

name

String

参数解释：

测量对象名称，即实例名称。

取值范围：

不涉及。

status

String

参数解释：

测量对象状态，即实例状态。

取值范围：

不涉及。

状态码：500

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

请求示例

GET https://{dcs_endpoint}}/v2/{project_id}}/dims/monitored-objects?dim_name={dim_name}

响应示例

状态码：200

查询主维度监控列表成功。

{
  "router" : [ "dcs_instance_id" ],
  "total" : 3,
  "children" : [ {
    "dim_name" : "dcs_cluster_redis_node",
    "dim_route" : "dcs_instance_id,dcs_cluster_redis_node"
  }, {
    "dim_name" : "dcs_cluster_proxy_node",
    "dim_route" : "dcs_instance_id,dcs_cluster_proxy_node"
  } ],
  "instances" : [ {
    "name" : "dcs-redis-single-node",
    "status" : "RUNNING",
    "dcs_instance_id" : "fe909c47-8990-44a0-9154-d0a1e95e78fe"
  }, {
    "name" : "dcs-redis-master-standby",
    "status" : "RUNNING",
    "dcs_instance_id" : "877e5ae3-482e-4c38-88a0-030a0fa6f399"
  }, {
    "name" : "dcs-proxy-cluster",
    "status" : "RUNNING",
    "dcs_instance_id" : "448ee851-1366-47f2-913a-e21032e690c4"
  } ]
}

状态码

状态码

描述

200

查询主维度监控列表成功。

500

内部服务错误。

错误码

请参见错误码。

父主题： 其他接口