查询单个主维度下子维度监控对象列表
功能介绍
查询主维度下子维度监控对象列表，当前支持子维度的主维度ID的有 dcs_instance_id。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/dims/monitored-objects/{instance_id}
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户ID。 |
instance_id |
是 |
String |
主维度对象ID，与DCS实例列表中实例ID相同。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
dim_name |
是 |
String |
主维度ID，当前支持子维度的主维度ID的有dcs_instance_id。 |
请求参数
无
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
router |
Array of strings |
当前查询维度路由。如果是主维度，则数组中是自身ID。 |
children |
Array of DimChild objects |
当前查询维度子维度对象列表。当前只有维度为dcs_instance_id时才有值。
|
instances |
Array of InstancesMonitoredObject objects |
当前查询维度监控对象列表。 |
dcs_cluster_redis_node |
Array of ClusterRedisNodeMonitoredObject objects |
Proxy集群或Cluster集群时才存在，表示集群数据节点维度的监控对象列表。字段名称与children的子维度对象名称相同。 |
dcs_cluster_proxy_node |
Array of ProxyNodeMonitoredObject objects |
Redis 3.0 Proxy集群时才存在，表示集群Proxy节点维度的监控对象列表。字段名称与children的子维度对象名称相同。 |
dcs_cluster_proxy2_node |
Array of Proxy2NodeMonitoredObject objects |
Redis 4.0和5.0的Proxy集群时才存在，表示集群Proxy节点维度的监控对象列表。字段名称与children的子维度对象名称相同。 |
total |
Integer |
主维度监控对象的总数。 |
参数 |
参数类型 |
描述 |
|---|---|---|
dim_name |
String |
维度名称，当前支持维度有dcs_instance_id、dcs_cluster_redis_node、 dcs_cluster_proxy_node和dcs_memcached_instance_id。 |
dim_route |
String |
维度的路由，结构为主维度名称,当前维度名称，比如： dim_name字段为dcs_cluster_redis_node时，这个字段的值为dcs_instance_id,dcs_cluster_redis_node。 |
参数 |
参数类型 |
描述 |
|---|---|---|
dcs_instance_id |
String |
测量对象ID，即实例的ID。 |
name |
String |
测量对象名称，即实例名称。 |
status |
String |
测量对象状态，即实例状态。 |
参数 |
参数类型 |
描述 |
|---|---|---|
dcs_instance_id |
String |
测量对象ID，即节点的ID。 |
name |
String |
测量对象名称，即节点IP。 |
dcs_cluster_redis_node |
String |
维度dcs_cluster_redis_node的测量对象的ID。 |
status |
String |
测量对象状态，即节点状态。 |
参数 |
参数类型 |
描述 |
|---|---|---|
dcs_instance_id |
String |
测量对象ID，即节点的ID。 |
name |
String |
测量对象名称，即节点IP。 |
dcs_cluster_proxy_node |
String |
维度dcs_cluster_proxy_node 的测量对象的ID。 |
status |
String |
测量对象状态，即节点状态。 |
参数 |
参数类型 |
描述 |
|---|---|---|
dcs_instance_id |
String |
测量对象ID，即节点的ID。 |
name |
String |
测量对象名称，即节点IP。 |
dcs_cluster_proxy2_node |
String |
维度dcs_cluster_proxy2_node 的测量对象的ID。 |
status |
String |
测量对象状态，即节点状态。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_msg |
String |
错误信息。 最大长度：1024 |
error_code |
String |
错误码。 最大长度：9 |
error_ext_msg |
String |
扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 |
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/dims/monitored-objects/{instance_id}?dim_name={dim_name}
响应示例
状态码： 200
查询主维度监控对象成功。
{
"router" : [ "dcs_instance_id" ],
"total" : 1,
"children" : [ {
"dim_name" : "dcs_cluster_redis_node",
"dim_route" : "dcs_instance_id,dcs_cluster_redis_node"
} ],
"instances" : [ {
"name" : "dcs-test001",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19"
} ],
"dcs_cluster_redis_node" : [ {
"name" : "(master)192.168.2.145",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "b1f4aa9e4dae50888e58c9caecdfc108"
}, {
"name" : "(replica)192.168.2.199",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "e0e10e489a73487147928167396474bc"
}, {
"name" : "(master)192.168.2.243",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "e797c3ba8bee782e25cdd4a90eb00517"
}, {
"name" : "(replica)192.168.2.164",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "d810fb44f9f7a359e000cf277a824c43"
}, {
"name" : "(master)192.168.2.95",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "f25c37a4654d50b07e629fc2adfba60f"
}, {
"name" : "(replica)192.168.2.51",
"status" : "RUNNING",
"dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
"dcs_cluster_redis_node" : "da5149a20dc7caf35587e4d2433fe452"
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
查询主维度监控对象成功。 |
500 |
内部服务错误。 |
错误码
请参见错误码。
