Help Center> Distributed Cache Service> API Reference> Other APIs> Querying Monitored Objects on Secondary Dimensions Under a Primary Dimension
View PDF

Querying 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.

This API is available only in the CN South regions.

URI

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

Table 1 URI parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Tenant ID.

instance_id

String

Yes

ID of the monitored object on the primary dimension, which is the instance ID.

dim_name

String

Yes

ID of the primary dimension. Value: dcs_instance_id.

Example:

GET https://dcs.cn-south-1.myhuaweicloud.com/v2/254d2280acb74d36a8b839746bcd7352/dims/monitored-objects/03ca9da0-1104-40a5-b49d-5ef8e41bfd19?dim_name=dcs_instance_id

Request

None

Response parameters

When the status code is 200, the response parameters are as follows.

Table 2 Response parameters

Parameter

Type

Description

children

Array of DimChild objects

Secondary dimensions under the specified dimension. This parameter is valid only when the dimension is dcs_instance_id.

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

Monitored objects on the primary dimension.

router

Array of strings

Route of the specified dimension. If the dimension is the primary dimension, the array contains the ID of the primary dimension.

total

Integer

Total number of monitored objects on the primary dimension.

dcs_cluster_redis_node

Array of ClusterRedisNodeMonitoredObject objects

Monitored objects of the Redis Server. This parameter is valid for Proxy Cluster and Redis Cluster instances.

dcs_cluster_proxy_node

Array of ProxyNodeMonitoredObject objects

Monitored objects of the Proxy. This parameter is valid only for Proxy Cluster instances.
Table 3 DimChild

Parameter

Type

Description

dim_name

String

Secondary dimension name. Options: dcs_instance_id, dcs_cluster_redis_node, dcs_cluster_proxy_node, and dcs_memcached_instance_id.

dim_route

String

Secondary dimension route. Format: Dimension name,Sub-dimension name. For example, if dim_name is dcs_cluster_redis_node, the value of dim_route is dcs_instance_id,dcs_cluster_redis_node.
Table 4 InstancesMonitoredObject

Parameter

Type

Description

name

String

Name of the monitored object, which is the instance name.

status

String

Status of the monitored object, which is the instance status.

dcs_instance_id

String

ID of the monitored object, which is the instance ID.
Table 5 ClusterRedisNodeMonitoredObject

Parameter

Type

Description

name

String

Name of the monitored object, which is the node IP address.

status

String

Status of the monitored object, which is the node status.

dcs_instance_id

String

ID of the monitored object, which is the node ID.

dcs_cluster_redis_node

String

ID of the monitored object on the dcs_cluster_redis_node dimension.
Table 6 ProxyNodeMonitoredObject

Parameter

Type

Description

name

String

Name of the monitored object, which is the node IP address.

status

String

Status of the monitored object, which is the node status.

dcs_instance_id

String

ID of the monitored object, which is the node ID.

dcs_cluster_proxy_node

String

ID of the monitored object on the dcs_cluster_proxy_node dimension.

Example Request

None

Example Response

When the status code is 200:

{
    "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"
        }
    ],
    "router": [
        "dcs_instance_id"
    ],
    "total": 1,
    "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"
        }
    ]
}

Return Value

Return Value

Description

200

Successfully queried the monitored objects on secondary dimensions under a primary dimension.
Parent topic: Other APIs