Help Center/ Distributed Cache Service/ API Reference/ API V2/ Other APIs/ Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension

Updated on 2025-05-13 GMT+08:00

Online Debugging

CLI Examples

View PDF

Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension

Function

This API is used to query the monitored objects on secondary dimensions under primary dimension dcs_instance_id.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A. Value range: N/A. Default value: N/A.
instance_id	Yes	String	Parameter description: ID of the monitored object on the primary dimension, which is the instance ID. Constraints: N/A. Value range: N/A. Default value: N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
dim_name	Yes	String	Parameter description: ID of the primary dimension, which can be dcs_instance_id. Constraints: N/A. Value range: N/A. Default value: N/A.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
router	Array of strings	Parameter description: Route of the specified dimension. If the dimension is the primary dimension, the array contains its ID. Value range: N/A.
children	Array of DimChild objects	Parameter description: Secondary dimensions under the specified dimension. This parameter is valid only when the dimension is dcs_instance_id. Value range: The secondary dimension of a Proxy Cluster instance can be dcs_cluster_redis_node or dcs_cluster_proxy_node. The secondary dimension of a Redis Cluster instance can be dcs_cluster_proxy_node.
instances	Array of InstancesMonitoredObject objects	Parameter description: Monitored objects of the specified dimension. Value range: N/A.
dcs_cluster_redis_node	Array of ClusterRedisNodeMonitoredObject objects	Parameter description: Monitored objects of the Redis Server. This parameter is valid for Proxy Cluster and Redis Cluster instances. The field name is the same as the secondary dimension object name under children. Value range: N/A.
dcs_cluster_proxy_node	Array of ProxyNodeMonitoredObject objects	Parameter description: Monitored objects of the Proxy. This parameter is valid only for Proxy Cluster DCS Redis 3.0 instances. The field name is the same as the secondary dimension object name under children. Value range: N/A.
dcs_cluster_proxy2_node	Array of Proxy2NodeMonitoredObject objects	Parameter description: Monitored objects of the Proxy. This parameter is valid only for Proxy Cluster DCS Redis 4.0 and 5.0 instances. The field name is the same as the secondary dimension object name under children. Value range: N/A.
total	Integer	Parameter description: Total number of monitored objects on the primary dimension. Value range: N/A.

**Table 4** DimChild
Parameter	Type	Description
dim_name	String	Parameter description: Dimension name. Value range: dcs_instance_id dcs_cluster_redis_node dcs_cluster_proxy_node dcs_memcached_instance_id
dim_route	String	Parameter description: Dimension route. Format: Primary dimension name,Secondary dimension name. For example, if dim_name is dcs_cluster_redis_node, the value of this field is dcs_instance_id,dcs_cluster_redis_node. Value range: N/A.

**Table 5** InstancesMonitoredObject
Parameter	Type	Description
dcs_instance_id	String	Parameter description: ID of the monitored object, which is the instance ID. Value range: N/A.
name	String	Parameter description: Name of the monitored object, which is the instance name. Value range: N/A.
status	String	Parameter description: Status of the monitored object, which is the instance status. Value range: N/A.

**Table 6** ClusterRedisNodeMonitoredObject
Parameter	Type	Description
dcs_instance_id	String	Parameter description: ID of the monitored object, which is the node ID. Value range: N/A.
name	String	Parameter description: Name of the monitored object, which is the node IP address. Value range: N/A.
dcs_cluster_redis_node	String	Parameter description: ID of the monitored object on the dcs_cluster_redis_node dimension. Value range: N/A.
status	String	Parameter description: Status of the monitored object, which is the node status. Value range: N/A.

**Table 7** ProxyNodeMonitoredObject
Parameter	Type	Description
dcs_instance_id	String	Parameter description: ID of the monitored object, which is the node ID. Value range: N/A.
name	String	Parameter description: Name of the monitored object, which is the node IP address. Value range: N/A.
dcs_cluster_proxy_node	String	Parameter description: ID of the monitored object on the dcs_cluster_proxy_node dimension. Value range: N/A.
status	String	Parameter description: Status of the monitored object, which is the node status. Value range: N/A.

**Table 8** Proxy2NodeMonitoredObject
Parameter	Type	Description
dcs_instance_id	String	Parameter description: ID of the monitored object, which is the node ID. Value range: N/A.
name	String	Parameter description: Name of the monitored object, which is the node IP address. Value range: N/A.
dcs_cluster_proxy2_node	String	Parameter description: ID of the monitored object on the dcs_cluster_proxy2_node dimension. Value range: N/A.
status	String	Parameter description: Status of the monitored object, which is the node status. Value range: N/A.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Example Requests

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

Example Responses

Status code: 200

Successfully queried the monitored objects on the primary dimension.

{
  "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"
  } ]
}