DescribeAvailableResource - Tair - Alibaba Cloud Documentation Center

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

Authorization information

There is currently no authorization information disclosed in the API.

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 NoteThe 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 database engine of the instance. Valid values: Redis Memcache	Redis
ResourceGroupId	string	No	The ID of the resource group to which to assign the instance. You can call the ListResourceGroups operation to query the IDs of resource groups. NoteYou 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 NoteThis parameter is available and required only if the OrderType parameter is set to UPGRADE or DOWNGRADE.	r-bp1zxszhcgatnx****
AcceptLanguage	string	No	The language of the return values. Defualt value: zh-CN. Valid values: zh-CN: Chinese en-US: English	zh-CN
ProductType	string	No	The series of the instance. Valid values: Local: ApsaraDB for Redis Community Edition instances that use local disks or ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based instances that use local disks Tair_rdb: ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based instances that use cloud disks Tair_scm: ApsaraDB for Redis Enhanced Edition (Tair) persistent memory-optimized instances Tair_essd: ApsaraDB for Redis Enhanced Edition (Tair) ESSD-based instances OnECS: ApsaraDB for Redis Community Edition instances that use cloud disks	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. NoteBefore 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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	493B7308-D9C2-55F6-B042-0313BD63****
AvailableZones	array	Details of available resources within zones.
	object
ZoneId	string	The ID of the zone.	cn-hangzhou-h
ZoneName	string	The name of the zone.
RegionId	string	The ID of the region.	cn-hangzhou
SupportedEngines	array	The available database engines.
	object
Engine	string	The database engine of the instance.	Redis
SupportedEditionTypes	array	The available instance editions.
	object
EditionType	string	The edition of the instance. Valid values: Community: Community Edition Enterprise: Enhance Edition (Tair)	Enterprise
SupportedSeriesTypes	array	The available instance series.
	object
SeriesType	string	The series of the instance. Valid values: enhanced_performance_type: ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based instances hybrid_storage: hybrid-storage instances	enhanced_performance_type
SupportedEngineVersions	array	The available engine versions.
	object
Version	string	The engine version of the instance.	5.0
SupportedArchitectureTypes	array	The available instance architectures.
	object
Architecture	string	The architecture of the instance. Valid values: standard: standard architecture cluster: cluster architecture rwsplit: read/write splitting architecture	cluster
SupportedShardNumbers	array	The numbers of shards that are allowed.
	object
ShardNumber	string	The number of shards in the instance.	8
SupportedNodeTypes	array	The available node types.
	object
SupportedNodeType	string	The node type of the instance. Valid values: single: single-replica double: a master node and a replica node	double
AvailableResources	array	The available instance types.
	object
InstanceClassRemark	string	The description of the instance type.
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 typein Document 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": "",
        "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": "",
                                                        "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.