Queries the configuration information of nodes in an ApsaraDB for Redis cluster instance, such as specifications and the maximum number of connections.

Note The instance must be a persistent memory-optimized instance in the cluster architecture.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeClusterMemberInfo

The operation that you want to perform. Set the value to DescribeClusterMemberInfo.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the ApsaraDB for Redis instance. You can call the DescribeInstances operation to query instance IDs.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query region IDs.

Response parameters

Parameter Type Example Description
ClusterChildren Array of Children

The data nodes in the cluster instance.

BandWidth Long 96

The maximum bandwidth of the data node. Unit: MB/s.

Note This parameter is returned only if the return value of the Service parameter is redis, which indicates a data node.
BinlogRetentionDays Integer 7

The retention period of binlogs.

BizType String ALIYUN

The type of workload. The return value is ALIYUN.

Capacity Long 1024

The maximum memory capacity per data node. Unit: MB.

Note This parameter is returned only if the return value of the Service parameter is redis, which indicates a data node.
ClassCode String redis.shard.small.ce

The specifications of the data node. For more information, see Persistent memory-optimized instances.

Connections Long 20000

The maximum number of connections supported by the data node.

CurrentBandWidth Long 100

The current bandwidth of the data node, which consists of the default bandwidth and the increased bandwidth. Unit: MB/s.

DiskSizeMB Integer 4096

The storage capacity of the enhanced solid-state disk (ESSD) that is mounted to the data node. Unit: MB.

Note The ESSD is used only to store system operating data, such as persistent data. It is not used as a medium to write and read data.
Id Long 501791111

The ID of the replica set on the node.

Name String r-bp1zxszhcgatnx****-db-0

The name of the node.

ReplicaSize Integer 0

The number of replicas.

ResourceGroupName String GLOBAL_ZHANGJIAKOU_A

The name of the resource group to which the node belongs.

Service String redis

The type of the node. Valid values:

  • redis: indicates a data node.
  • configServer: indicates the ConfigServer node.
ServiceVersion String 5.0

The major version of the node.

UserId String 2****_176498472570****

The ID of the user.

RequestId String 2D9F3768-EDA9-4811-943E-42C8006E****

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=DescribeClusterMemberInfo
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format

<DescribeClusterMemberInfoResponse>
      <RequestId>D5362666-6A31-4DF6-99EB-93A74602****</RequestId>
      <ClusterChildren>
            <Service>redis_cs</Service>
            <BizType>ALIYUN</BizType>
            <DiskSizeMB>1024</DiskSizeMB>
            <Name>r-8vbktttx3r6izp****-cs-0</Name>
            <BinlogRetentionDays>7</BinlogRetentionDays>
            <ClassCode>redis.sharding.midce.cs.default</ClassCode>
            <UserId>2****_176498472570****</UserId>
            <ServiceVersion>5.0</ServiceVersion>
            <Id>501791111</Id>
            <ReplicaSize>0</ReplicaSize>
            <ResourceGroupName>GLOBAL_ZHANGJIAKOU_A</ResourceGroupName>
      </ClusterChildren>
      <ClusterChildren>
            <Connections>20000</Connections>
            <Service>redis</Service>
            <BizType>ALIYUN</BizType>
            <DiskSizeMB>4096</DiskSizeMB>
            <Name>r-8vbktttx3r6izp****-db-1</Name>
            <BinlogRetentionDays>7</BinlogRetentionDays>
            <BandWidth>96</BandWidth>
            <ClassCode>redis.shard.small.ce</ClassCode>
            <Capacity>1024</Capacity>
            <UserId>2****_176498472570****</UserId>
            <ServiceVersion>5.0</ServiceVersion>
            <Id>501791111</Id>
            <ReplicaSize>0</ReplicaSize>
            <ResourceGroupName>GLOBAL_ZHANGJIAKOU_A</ResourceGroupName>
      </ClusterChildren>
      <ClusterChildren>
            <Connections>20000</Connections>
            <Service>redis</Service>
            <BizType>ALIYUN</BizType>
            <DiskSizeMB>4096</DiskSizeMB>
            <Name>r-8vbktttx3r6izp****-db-2</Name>
            <BinlogRetentionDays>7</BinlogRetentionDays>
            <BandWidth>96</BandWidth>
            <ClassCode>redis.shard.small.ce</ClassCode>
            <Capacity>1024</Capacity>
            <UserId>2****_176498472570****</UserId>
            <ServiceVersion>5.0</ServiceVersion>
            <Id>501791111</Id>
            <ReplicaSize>0</ReplicaSize>
            <ResourceGroupName>GLOBAL_ZHANGJIAKOU_A</ResourceGroupName>
      </ClusterChildren>
</DescribeClusterMemberInfoResponse>

JSON format

{
	"RequestId": "D5362666-6A31-4DF6-99EB-93A74602****",
	"ClusterChildren": [
		{
			"Service": "redis_cs",
			"BizType": "ALIYUN",
			"DiskSizeMB": 1024,
			"Name": "r-8vbktttx3r6izp****-cs-0",
			"BinlogRetentionDays": 7,
			"ClassCode": "redis.sharding.midce.cs.default",
			"UserId": "2****_176498472570****",
			"ServiceVersion": "5.0",
			"Items": [],
			"Id": 501791111,
			"ReplicaSize": 0,
			"ResourceGroupName": "GLOBAL_ZHANGJIAKOU_A"
		},
		{
			"Connections": 20000,
			"Service": "redis",
			"BizType": "ALIYUN",
			"DiskSizeMB": 4096,
			"Name": "r-8vbktttx3r6izp****-db-1",
			"BinlogRetentionDays": 7,
			"BandWidth": 96,
			"ClassCode": "redis.shard.small.ce",
			"Capacity": 1024,
			"UserId": "2****_176498472570****",
			"ServiceVersion": "5.0",
			"Items": [],
			"Id": 501791111,
			"ReplicaSize": 0,
			"ResourceGroupName": "GLOBAL_ZHANGJIAKOU_A"
		},
		{
			"Connections": 20000,
			"Service": "redis",
			"BizType": "ALIYUN",
			"DiskSizeMB": 4096,
			"Name": "r-8vbktttx3r6izp****-db-2",
			"BinlogRetentionDays": 7,
			"BandWidth": 96,
			"ClassCode": "redis.shard.small.ce",
			"Capacity": 1024,
			"UserId": "2****_176498472570****",
			"ServiceVersion": "5.0",
			"Items": [],
			"Id": 501791111,
			"ReplicaSize": 0,
			"ResourceGroupName": "GLOBAL_ZHANGJIAKOU_A"
		}
	]
}

Error codes

For a list of error codes, visit the API Error Center.