Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Distributed Cache Service/ API Reference (Paris Region)/ API V2/ Other APIs/ Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension

Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension

Updated on 2023-12-13 GMT+08:00

Function

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant ID.

instance_id

Yes

String

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

dim_name

Yes

String

ID of the primary dimension, which can be dcs_instance_id.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

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.

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 of the specified 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. The field name is the same as the secondary dimension object name under children.

dcs_cluster_proxy_node

Array of ProxyNodeMonitoredObject objects

Monitored objects of proxies. 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.

dcs_cluster_proxy2_node

Array of Proxy2NodeMonitoredObject objects

Monitored objects of the Proxy. This parameter is valid only for Redis 4.0 and 5.0 Proxy Cluster instances. The field name is the same as the secondary dimension object name under children.

total

Integer

Total number of monitored objects on the primary dimension.

Table 4 DimChild

Parameter

Type

Description

dim_name

String

Dimension name. The value can be dcs_instance_id, dcs_cluster_redis_node, dcs_memcached_instance_id or dcs_cluster_proxy_node.

dim_route

String

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 5 InstancesMonitoredObject

Parameter

Type

Description

dcs_instance_id

String

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

name

String

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

status

String

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

Table 6 ClusterRedisNodeMonitoredObject

Parameter

Type

Description

dcs_instance_id

String

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

name

String

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

dcs_cluster_redis_node

String

ID of the monitored object on the dcs_cluster_redis_node dimension.

status

String

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

Table 7 ProxyNodeMonitoredObject

Parameter

Type

Description

dcs_instance_id

String

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

name

String

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

dcs_cluster_proxy_node

String

ID of the monitored object on the dcs_cluster_proxy_node dimension.

status

String

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

Table 8 Proxy2NodeMonitoredObject

Parameter

Type

Description

dcs_instance_id

String

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

name

String

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

dcs_cluster_proxy2_node

String

ID of the monitored object on the dcs_cluster_proxy2_node dimension.

status

String

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

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Maximum: 1024

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

Status Codes

Status Code

Description

200

Successfully queried the monitored objects on the primary dimension.

500

Internal service error.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback