Use DescribeClusterMemberInfo to query node configuration information - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries node configuration in a Tair (Redis OSS-compatible) cluster instance, such as specifications and maximum connections.

Operation description

Note

This operation applies only to Tair (Redis OSS-compatible) instances that use cloud disks and the cluster architecture.

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:DescribeClusterMemberInfo

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. Call DescribeInstances to query instance IDs.	r-bp1zxszhcgatnx****
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Valid values: 30, 50, and 100. Default: 30.	30

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	2D9F3768-EDA9-4811-943E-42C8006E****
ClusterChildren	array<object>	The data nodes in the cluster instance.
	object
Capacity	integer	The maximum memory capacity per data node. Unit: MB. Note Returned only when Service is redis (data node).	1024
UserId	string	The user ID.	2**_176498472570**
DiskSizeMB	integer	The ESSD storage capacity of the data node. Unit: MB. Note The ESSD stores only system operating data such as Persistent Memory (PMEM), not user read/write data.	4096
BandWidth	integer	The maximum bandwidth of the node. Unit: MB/s. Note Returned only when Service is redis (data node).	96
CurrentBandWidth	integer	The current bandwidth of the data node (default + purchased extra bandwidth). Unit: Mbit/s.	100
ClassCode	string	The data node specifications listed in Community Edition instances that use cloud disks.	redis.shard.small.ce
BizType	string	The workload type. Returns ALIYUN.	ALIYUN
Service	string	The node type. Valid values: redis: data node redis_cs: config server	redis
BinlogRetentionDays	integer	The binlog retention period.	7
Connections	integer	The maximum number of connections for the data node.	20000
ResourceGroupName	string	The resource group name of the node.	GLOBAL_ZHANGJIAKOU_A
ServiceVersion	string	The node major version.	5.0
ReplicaSize	integer	The replica node count.	0
Name	string	The data node name.	r-bp1zxszhcgatnx****-db-0
Id	integer	The replica set ID in the node.	501791111

Examples

Success response

JSON format

{
  "RequestId": "2D9F3768-EDA9-4811-943E-42C8006E****",
  "ClusterChildren": [
    {
      "Capacity": 1024,
      "UserId": "2****_176498472570****",
      "DiskSizeMB": 4096,
      "BandWidth": 96,
      "CurrentBandWidth": 100,
      "ClassCode": "redis.shard.small.ce",
      "BizType": "ALIYUN",
      "Service": "redis",
      "BinlogRetentionDays": 7,
      "Connections": 20000,
      "ResourceGroupName": "GLOBAL_ZHANGJIAKOU_A",
      "ServiceVersion": "5.0",
      "ReplicaSize": 0,
      "Name": "r-bp1zxszhcgatnx****-db-0",
      "Id": 501791111
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.