DescribeLogicInstanceTopology - Tair (Redis® OSS-Compatible)

Queries the logical topology of an ApsaraDB for Redis instance.

Operation description

This parameter is supported only for cluster and read/write splitting instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeLogicInstanceTopology	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance whose topology information you want to query.	r-bp1zxszhcgatnx****

Response parameters

Parameter	Type	Description	Example
	object
InstanceId	string	The ID of the instance.	r-bp1zxszhcgatnx****
RequestId	string	The ID of the request.	794120D1-E0CF-4713-BAE4-EBAEA04506AF
RedisProxyList	array<object>	The information about proxy nodes.
NodeInfo	object
Capacity	string	The storage capacity of the node. Unit: MB.	5120
Connection	string	The maximum number of connections.	320000
NodeType	string	The node type. Valid values: db: a data node. normal: a management node, which can be a proxy node or a Configserver node. For specific instances, the return value of this parameter is proxy or cs, instead of normal.	proxy
Bandwidth	string	The maximum bandwidth of the node. Unit: Mbit/s.	96
NodeId	string	The ID of the node.	r-bp10noxlhcoim2**-proxy-3#542**
RedisShardList	array<object>	Details of data shards, including node information such as NodeInfo.
NodeInfo	object
Capacity	string	The storage capacity of the node. Unit: MB.	2048
Connection	string	The maximum number of connections.	10000
NodeType	string	The node type. Valid values: proxy: proxy node db: data node	db
Bandwidth	string	The maximum bandwidth of the node. Unit: Mbit/s.	96
NodeId	string	The ID of the node.	r-bp10noxlhcoim2**-db-0#688**
SubInstanceType	string	The type of the child instance. Valid values: master: master node readonly: read-only instance	master

Examples

Sample success responses

JSONformat

{
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "794120D1-E0CF-4713-BAE4-EBAEA04506AF",
  "RedisProxyList": {
    "NodeInfo": [
      {
        "Capacity": "5120",
        "Connection": "320000",
        "NodeType": "proxy",
        "Bandwidth": "96",
        "NodeId": "r-bp10noxlhcoim2****-proxy-3#542****"
      }
    ]
  },
  "RedisShardList": {
    "NodeInfo": [
      {
        "Capacity": "2048",
        "Connection": "10000",
        "NodeType": "db",
        "Bandwidth": "96",
        "NodeId": "r-bp10noxlhcoim2****-db-0#688****",
        "SubInstanceType": "master"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-08-21	The response structure of the API has changed	View Change Details