查询主维度信息列表
功能介绍
查询主维度对象列表，主维度ID当前支持dcs_instance_id，dcs_memcached_instance_id。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/dims/monitored-objects
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dim_name |
是 |
String |
主维度ID，当前支持dcs_instance_id，dcs_memcached_instance_id。 |
|
offset |
否 |
Integer |
偏移量，表示从此偏移量开始查询，offset大于等于0。 |
|
limit |
否 |
Integer |
每页显示的条目数量。 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
router |
Array of strings |
当前查询维度路由。如果是主维度，则数组中是自身ID。 |
|
children |
Array of DimChild objects |
当前查询维度子维度对象列表。当前只有维度为dcs_instance_id时才有值。
|
|
instances |
Array of InstancesMonitoredObject objects |
当前查询维度监控对象列表。 |
|
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 |
测量对象状态，即实例状态。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
内部服务错误。 |
错误码
请参见错误码。
