Use DescribeDedicatedClusterInstanceList to query instances in a dedicated cluster - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries Tair (Redis OSS-compatible) instances deployed in a dedicated cluster.

Operation description

Note

To query Tair (Redis OSS-compatible) instances that are not deployed in a dedicated cluster, call the DescribeInstanceAttribute operation.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. Call the DescribeRegions operation to query available regions.	cn-hangzhou
ZoneId	string	No	The zone ID of the instance. Call the DescribeZones operation to query available zones.	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 find this ID on the Dedicated Clusters page of 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. Call the DescribeDedicatedHosts operation to query host IDs. Note Separate multiple IDs with commas (,).	ch-t4n664a9mal4c****
PageNumber	integer	No	The page number to return. The value must be an integer 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 elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	25
RequestId	string	The ID of the request.	712CCF2A-16BD-411B-93F7-E978BEF2****
TotalCount	integer	The total number of entries returned.	0
Instances	array<object>	Details about the instances.
	array<object>	Details about the instance.
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	integer	The default bandwidth of the instance. Unit: Mbit/s.	24
CurrentBandWidth	integer	The current bandwidth of the instance, which is the sum of the default bandwidth and any purchased extra bandwidth. 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.	3
CustomId	string	An internal parameter for instance maintenance and management.	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.	1
ClusterId	string	The ID of the dedicated cluster to which the instance belongs.	dhg-rx71fc5ndh9o****
InstanceNodeList	array<object>	Details about the nodes.
	object	Details about the node.
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 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

Success response

JSON format

{
  "PageNumber": 1,
  "PageSize": 25,
  "RequestId": "712CCF2A-16BD-411B-93F7-E978BEF2****",
  "TotalCount": 0,
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.