Query the logical topology of an instance by using DescribeLogicInstanceTopology - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries the logical topology structure of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance.

Operation description

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeLogicInstanceTopology

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	r-bp1zxszhcgatnx****

Response elements

Element	Type	Description	Example
	object
InstanceId	string	The instance ID.	r-bp1zxszhcgatnx****
RequestId	string	The request ID.	794120D1-E0CF-4713-BAE4-EBAEA04506AF
RedisProxyList	object
NodeInfo	array<object>	The proxy details, including proxy node information.
	object
Capacity	string	The capacity of the node. Unit: MB.	5120
Connection	string	The maximum number of connections.	320000
NodeType	string	The node type. Valid values: db: data node. normal: management node, which consists of a proxy node and a CS (configuration server) node. Some instances do not return normal but instead return proxy and cs separately.	proxy
Bandwidth	string	The bandwidth limit of the node. Unit: MB/s.	96
NodeId	string	The node ID.	r-bp10noxlhcoim2**-proxy-3#542**
RedisShardList	object
NodeInfo	array<object>	The shard details, including child node information such as NodeInfo.
	object
Capacity	string	The 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 bandwidth limit of the node. Unit: MB/s.	96
NodeId	string	The node ID.	r-bp10noxlhcoim2**-db-0#688**
SubInstanceType	string	The sub-instance type. Valid values: master: primary node. readonly: read-only instance.	master

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.