All Products
Search
Document Center

ApsaraDB for Redis:DescribeClusterMemberInfo

Last Updated:May 28, 2024

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

Operation description

Note This API operation is applicable only to ApsaraDB for Redis instances that use cloud disks and the cluster architecture.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:DescribeClusterMemberInfoRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

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

r-bp1zxszhcgatnx****
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.

30

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

2D9F3768-EDA9-4811-943E-42C8006E****
ClusterChildrenobject []

Details of nodes in the cluster instance.

Capacitylong

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

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

The ID of the user.

2****_176498472570****
DiskSizeMBinteger

The storage capacity of the enhanced SSD (ESSD) that is used by the data node. Unit: MB.

Note The ESSD is used only to store system operating data, such as Persistent Memory (PMEM). It is not used as a medium to write and read data.
4096
BandWidthlong

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

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

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

Note This parameter is returned only if the instance is created in a dedicated cluster.
100
ClassCodestring

The specifications of the data node. For more information, see Community Edition instances that use cloud disks.

redis.shard.small.ce
BizTypestring

The type of workload. The return value is ALIYUN.

ALIYUN
Servicestring

The node type. Valid values:

  • redis: data node
  • redis_cs: config server
redis
BinlogRetentionDaysinteger

The retention period of binlogs.

7
Connectionslong

The maximum number of connections supported by the data node.

20000
ResourceGroupNamestring

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

GLOBAL_ZHANGJIAKOU_A
ServiceVersionstring

The major version of the node.

5.0
ReplicaSizeinteger

The number of replica nodes.

0
Namestring

The name of the data node.

r-bp1zxszhcgatnx****-db-0
Idlong

The ID of the replica set in the node.

501791111

Examples

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
2023-07-06The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: PageNumber
    Added Input Parameters: PageSize