DescribeDedicatedClusterInstanceList - Tair (Redis® OSS-Compatible)

Queries the information of an ApsaraDB for Redis instance deployed in a dedicated cluster.

Operation description

Note If you want to query the information about ApsaraDB for Redis instances that are not deployed in a dedicated cluster, call the DescribeInstanceAttribute operation.

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:DescribeDedicatedClusterInstanceList	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ZoneId	string	No	The zone ID of the instance. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-e
InstanceId	string	No	The ID of the instance. Note The instance must be created by using a dedicated cluster. For more information, see What is ApsaraDB for MyBase?	r-bp1zxszhcgatnx****
InstanceStatus	integer	No	The state of the instance. Valid values: 0: The instance is being created. 1: The instance is running. 3: The instance is being deleted. 5: The configurations of the instance are being changed. 6: The instance is being migrated. 7: The instance is being restored from a backup. 8: A master-replica switchover is in progress. 9: Expired data of the instance is being deleted.	1
InstanceNetType	string	No	The network type of the instance. Valid values: 0: Internet 1: classic network 2: Virtual Private Cloud (VPC)	2
Engine	string	No	The database engine of the instance. Set the value to Redis.	Redis
EngineVersion	string	No	The database engine version of the instance. Set the value to 5.0.	5.0
ClusterId	string	No	The ID of the dedicated cluster. You can view the dedicated cluster ID on the Dedicated Clusters page in the ApsaraDB for MyBase console. Note Separate multiple IDs with commas (,).	dhg-5f2v98840ioq****
DedicatedHostName	string	No	The ID of the host in the dedicated cluster. You can call the DescribeDedicatedHosts operation to query the host ID. Note Separate multiple IDs with commas (,).	ch-t4n664a9mal4c****
PageNumber	integer	No	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.	30

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	30
RequestId	string	The ID of the request.	712CCF2A-16BD-411B-93F7-E978BEF2****
TotalCount	integer	The total number of entries returned.	1
Instances	array<object>	Details of the instances.
Instances	object
VpcId	string	The VPC ID.	vpc-t4n2clc70t3hqwsrr****
CharacterType	string	The architecture of the instance. Valid values: logic: cluster normal: standard	logic
VswitchId	string	The vSwitch ID.	vsw-t4nvrca24dczppq44****
InstanceClass	string	The instance type.	redis.cluster.sharding.common.ce
MaintainStartTime	string	The start time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC.	16:00Z
CreateTime	string	The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-05-06T07:09:40Z
ConnectionDomain	string	The private endpoint of the instance.	r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com
MaintainEndTime	string	The end time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC.	17:00Z
StorageType	string	The storage type of the instance. The return value is LOCAL_SSD, which indicates enhanced SSDs (ESSDs).	LOCAL_SSD
InstanceId	string	The ID of the instance.	r-bp1e7vl6ygf1yq****
BandWidth	long	The default bandwidth of the instance. Unit: Mbit/s.	24
CurrentBandWidth	long	The current bandwidth of the instance, which is the sum of the default bandwidth and any extra bandwidth that is purchased. Unit: Mbit/s.	50
EngineVersion	string	The database engine version of the instance. The return value is 5.0.	5.0
RegionId	string	The ID of the region.	cn-hangzhou
InstanceName	string	The instance name.	testdb
ZoneId	string	The zone ID.	cn-hangzhou-e
ClusterName	string	The name of the dedicated cluster to which the instance belongs.	testname
InstanceStatus	string	The state of the instance. Valid values: Normal: The instance is normal. Creating: The instance is being created. Changing: The configurations of the instance are being changed. Inactive: The instance is disabled. Flushing: The instance is being released. Released: The instance is released. Transforming: The billing method of the instance is being changed. Unavailable: The instance is unavailable. Error: The instance failed to be created. Migrating: The instance is being migrated. BackupRecovering: The instance is being restored from a backup. MinorVersionUpgrading: The minor version of the instance is being updated. NetworkModifying: The network type of the instance is being changed. SSLModifying: The SSL configurations of the instance are being changed. MajorVersionUpgrading: The major version of the instance is being upgraded. The instance remains accessible during the upgrade.	Normal
Engine	string	The database engine. The return value is redis.	redis
ShardCount	integer	The number of shards. Note This parameter is returned only when the instance is a cluster instance. For more information about cluster instances, see Cluster master-replica instances.	3
CustomId	string	An internal parameter used for the maintenance and management of instances.	4652****
ProxyCount	integer	The number of proxy nodes. Note If the return value is 0, the proxy mode is disabled for the instance. If the return value is an integer greater than 0, such as 1, the proxy mode is enabled for the instance. This parameter is returned only when the instance is a cluster instance. For more information about cluster instances, see Cluster master-replica instances.	1
ClusterId	string	The ID of the dedicated cluster to which the instance belongs.	dhg-rx71fc5ndh9o****
InstanceNodeList	array<object>	The nodes.
InstanceNodes	object
NodeIp	string	The IP address of the node.	10.0.33.***
DedicatedHostName	string	The ID of the host in the dedicated cluster.	ch-bp13vf0y9gx3c****
NodeType	string	The node type. Valid values: db: data node. proxy: proxy node. normal: regular node. This value is returned when the instance runs in the standard architecture.	normal
ZoneId	string	The zone ID of the node.	cn-hangzhou-h
InstanceId	string	The ID of the instance.	r-bp1e7vl6ygf1yq****
Port	integer	The port number that is used to connect to the node.	3001
Role	string	The role of the node. Valid values: master: master node slave: replica node	master
NodeId	integer	The node ID.	17921111

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "712CCF2A-16BD-411B-93F7-E978BEF2****",
  "TotalCount": 1,
  "Instances": [
    {
      "VpcId": "vpc-t4n2clc70t3hqwsrr****",
      "CharacterType": "logic",
      "VswitchId": "vsw-t4nvrca24dczppq44****",
      "InstanceClass": "redis.cluster.sharding.common.ce",
      "MaintainStartTime": "16:00Z",
      "CreateTime": "2021-05-06T07:09:40Z",
      "ConnectionDomain": "r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com",
      "MaintainEndTime": "17:00Z",
      "StorageType": "LOCAL_SSD",
      "InstanceId": "r-bp1e7vl6ygf1yq****",
      "BandWidth": 24,
      "CurrentBandWidth": 50,
      "EngineVersion": "5.0",
      "RegionId": "cn-hangzhou",
      "InstanceName": "testdb",
      "ZoneId": "cn-hangzhou-e",
      "ClusterName": "testname",
      "InstanceStatus": "Normal",
      "Engine": "redis",
      "ShardCount": 3,
      "CustomId": "4652****",
      "ProxyCount": 1,
      "ClusterId": "dhg-rx71fc5ndh9o****",
      "InstanceNodeList": [
        {
          "NodeIp": "10.0.33.***",
          "DedicatedHostName": "ch-bp13vf0y9gx3c****",
          "NodeType": "normal",
          "ZoneId": "cn-hangzhou-h",
          "InstanceId": "r-bp1e7vl6ygf1yq****",
          "Port": 3001,
          "Role": "master",
          "NodeId": 17921111
        }
      ]
    }
  ]
}

Error codes

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