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

Querying Monitored Objects on Primary Dimensions

Function

This API is used to query the monitored objects on primary dimensions dcs_instance_id and dcs_memcached_instance_id.

This API is available only in the CN South regions.

URI

GET /v2/{project_id}/dims/monitored-objects?dim_name={dim_name}&offset={offset}&limit={limit}

Table 1 URI parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.

dim_name

String

Yes

Primary dimension ID. Options: dcs_instance_id and dcs_memcached_instance_id.

offset

Integer

No

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

Integer

No

Number of items displayed per page.

Example:

GET https://dcs.cn-south-1.myhuaweicloud.com/v2/254d2280acb74d36a8b839746bcd7352/dims/monitored-objects?dim.0.name=dcs_instance_id

Request

None

Response

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 a primary 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

Primary dimension route. Currently, only the dimension ID is included in the value.

total

Integer

Total number of monitored objects on the primary dimension.
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.

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

Return Value

Return Value

Description

200

Successfully queried the monitored objects on the primary dimension.
Parent topic: Other APIs