DescribeAvailableResource - Tair (Redis® OSS-Compatible)

Queries the types of ApsaraDB for Redis instances that can be created in a specified zone.

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:DescribeAvailableResource	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-h
InstanceChargeType	string	No	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go Note The default value is PrePaid.	PrePaid
OrderType	string	No	The type of the order. Default value: BUY. Valid values: BUY: orders that are newly created UPGRADE: orders that are used to upgrade instances DOWNGRADE: orders that are used to downgrade instances	BUY
Engine	string	No	The category of the instance. Valid values: Redis Memcache	Redis
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs. You can call the ListResourceGroups operation to query the IDs of resource groups. Note You can also query the IDs of resource groups in the Resource Management console. For more information, see View basic information about a resource group.	rg-acfmyiu4e******
InstanceId	string	No	The ID of the instance. Note This parameter is available and required only if the OrderType parameter is set to UPGRADE or DOWNGRADE.	r-bp1zxszhcgatnx****
AcceptLanguage	string	No	The display language of the response. Default value: zh-CN. Valid values: zh-CN: Chinese en-US: English	zh-CN
ProductType	string	No	The series of the instance. Valid values: Local: classic ApsaraDB for Redis Community Edition instance or classic ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based instance Tair_rdb: cloud-native ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based instance Tair_scm: ApsaraDB for Redis Enhanced Edition (Tair) persistent memory-optimized instance Tair_essd: ESSD-based instance OnECS: cloud-native ApsaraDB for Redis Community Edition instance	Local
NodeId	string	No	The ID of the data node for which you want to query available resources that can be created. You can call the DescribeLogicInstanceTopology operation to query the ID of the data node. Remove the number sign (`#`) and the content that follows the number sign. For example, retain only r-bp10noxlhcoim2**-db-0. Note Before you specify this parameter, you must set the InstanceId** parameter to the ID of an instance that uses the cluster or read/write splitting architecture.	r-bp1zxszhcgatnx****-db-0
InstanceScene	string	No	The edition of the instance. Valid values: professional: Standard Edition. This edition supports the standalone, master-replica, read /write splitting, and cluster architectures and provides high scalability.	professional

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	493B7308-D9C2-55F6-B042-0313BD63****
AvailableZones	array<object>	Details of the zones.
AvailableZone	object
ZoneId	string	The ID of the zone in which the instance is located.	cn-hangzhou-h
ZoneName	string	The name of the zone.	Hangzhou Zone H
RegionId	string	The ID of the region.	cn-hangzhou
SupportedEngines	array<object>	The available database engines.
SupportedEngine	object
Engine	string	The database engine of the instance.	Redis
SupportedEditionTypes	array<object>	The available instance editions.
SupportedEditionType	object
EditionType	string	The edition of the instance. Valid values: Community: Community Edition Enterprise: Enhanced Edition (Tair)	Enterprise
SupportedSeriesTypes	array<object>	The available instance series.
SupportedSeriesType	object
SeriesType	string	The instance series. Valid values: enhanced_performance_type: ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based instance hybrid_storage: ApsaraDB for Redis Community Edition hybrid-storage instance	enhanced_performance_type
SupportedEngineVersions	array<object>	The available engine versions.
SupportedEngineVersion	object
Version	string	The engine version of the instance.	5.0
SupportedArchitectureTypes	array<object>	The available instance architectures.
SupportedArchitectureType	object
Architecture	string	The architecture of the instance. Valid values: standard: standard architecture cluster: cluster architecture rwsplit: read/write splitting architecture	cluster
SupportedShardNumbers	array<object>	The numbers of shards that are allowed.
SupportedShardNumber	object
ShardNumber	string	The number of shards.	8
SupportedNodeTypes	array<object>	The available node types.
SupportedNodeType	object
SupportedNodeType	string	The node type of the instance. Valid values: single: standalone double: master-replica	double
AvailableResources	array<object>	The available instance types.
AvailableResource	object
InstanceClassRemark	string	The description of the instance type.	16 GB cluster instance with 8 nodes (1,920,000 queries per second and 240,000 connections)
Capacity	long	The memory size of the instance. Unit: MB.	16384
InstanceClass	string	The code of the instance type. If you want to view the code of an instance type, you can search for the code of the instance type in Help Center.	redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread

Examples

Sample success responses

JSONformat

{
  "RequestId": "493B7308-D9C2-55F6-B042-0313BD63****",
  "AvailableZones": {
    "AvailableZone": [
      {
        "ZoneId": "cn-hangzhou-h",
        "ZoneName": "Hangzhou Zone H\n",
        "RegionId": "cn-hangzhou",
        "SupportedEngines": {
          "SupportedEngine": [
            {
              "Engine": "Redis",
              "SupportedEditionTypes": {
                "SupportedEditionType": [
                  {
                    "EditionType": "Enterprise",
                    "SupportedSeriesTypes": {
                      "SupportedSeriesType": [
                        {
                          "SeriesType": "enhanced_performance_type",
                          "SupportedEngineVersions": {
                            "SupportedEngineVersion": [
                              {
                                "Version": "5.0",
                                "SupportedArchitectureTypes": {
                                  "SupportedArchitectureType": [
                                    {
                                      "Architecture": "cluster",
                                      "SupportedShardNumbers": {
                                        "SupportedShardNumber": [
                                          {
                                            "ShardNumber": "8",
                                            "SupportedNodeTypes": {
                                              "SupportedNodeType": [
                                                {
                                                  "SupportedNodeType": "double",
                                                  "AvailableResources": {
                                                    "AvailableResource": [
                                                      {
                                                        "InstanceClassRemark": "16 GB cluster instance with 8 nodes (1,920,000 queries per second and 240,000 connections)\n",
                                                        "Capacity": 16384,
                                                        "InstanceClass": "redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread"
                                                      }
                                                    ]
                                                  }
                                                }
                                              ]
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-07-25	The request parameters of the API has changed	View Change Details