Use DescribeAvailableResource to query available resources - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries the types of Tair (Redis OSS-compatible) instances that can be created in a specified zone.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query available regions.	cn-hangzhou
ZoneId	string	No	The zone ID. You can call the DescribeZones operation to query available zones.	cn-hangzhou-h
InstanceChargeType	string	No	The billing method. Valid values: PrePaid (default): subscription PostPaid: pay-as-you-go	PrePaid
OrderType	string	No	The order type. Valid values: BUY (default): orders that are used to create instances 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 resource group ID. You can call the ListResourceGroups operation to query resource group IDs. Note You can also query resource group IDs 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 language of the response. Valid values: zh-CN: Chinese. This is the default value. en-US: English.	zh-CN
ProductType	string	No	The instance type. Default value: Local. Valid values: Local: classic Redis Open-Source Edition instance or classic DRAM-based instance Tair_rdb: cloud-native DRAM-based instance Tair_scm: persistent memory-optimized instance Tair_essd: ESSD/SSD-based instance OnECS: cloud-native Redis Open-Source Edition instance Note The default value of this parameter is Local. To query disk resources, you must specify the instance type that provides the required disk resources.	Local
NodeId	string	No	The data node ID. You can call the DescribeLogicInstanceTopology operation to query data node IDs. Remove the number sign (`#`) and everything after it. 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. Supports standalone, master-replica, read/write splitting, and cluster architectures with high scalability.	professional

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	493B7308-D9C2-55F6-B042-0313BD63****
AvailableZones	object
AvailableZone	array<object>	Details about the zones.
	array<object>
ZoneId	string	The zone ID.	cn-hangzhou-h
ZoneName	string	The name of the zone.	杭州可用区H
RegionId	string	The ID of the region.	cn-hangzhou
SupportedEngines	object
SupportedEngine	array<object>	The supported engines.
	array<object>
Engine	string	The database engine of the instance.	Redis
SupportedEditionTypes	object
SupportedEditionType	array<object>	The instance edition types.
	array<object>
EditionType	string	The edition of the instance. Valid values: Community: Community Edition Enterprise: Enhanced Edition (Tair)	Enterprise
SupportedSeriesTypes	object
SupportedSeriesType	array<object>	The instance series types.
	array<object>
SeriesType	string	The instance series. Valid values: enhanced_performance_type: Tair (Enterprise Edition) DRAM-based instance hybrid_storage: Redis Open-Source Edition hybrid-storage instance	enhanced_performance_type
SupportedEngineVersions	object
SupportedEngineVersion	array<object>	The available engine versions.
	array<object>
Version	string	The engine version of the instance.	5.0
SupportedArchitectureTypes	object
SupportedArchitectureType	array<object>	The available architectures.
	array<object>
Architecture	string	The architecture of the instance. Valid values: standard: standard architecture cluster: cluster architecture rwsplit: read/write splitting architecture	cluster
SupportedShardNumbers	object
SupportedShardNumber	array<object>	The numbers of available shards.
	array<object>
ShardNumber	string	The number of shards.	8
SupportedNodeTypes	object
SupportedNodeType	array<object>	The supported node types.
	array<object>	The supported node type.
SupportedNodeType	string	The node type of the instance. Valid values: single: standalone double: master-replica	double
AvailableResources	object
AvailableResource	array<object>	The available instance types.
	object	The available instance type.
InstanceClassRemark	string	The description of the instance type.	16G集群版（8节点）（QPS:1920000 Connections:240000）
Capacity	integer	The memory size of the instance. Unit: MB.	16384
InstanceClass	string	The instance type code. For details about instance type codes, see the instance type documentation in Help Center.	redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread
IsMainSale	boolean	An internal parameter.	true

Examples

Success response

JSON format

{
  "RequestId": "493B7308-D9C2-55F6-B042-0313BD63****",
  "AvailableZones": {
    "AvailableZone": [
      {
        "ZoneId": "cn-hangzhou-h",
        "ZoneName": "杭州 可用区H",
        "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": "16G集群版（8节点）（QPS:1920000 Connections:240000）",
                                                        "Capacity": 16384,
                                                        "InstanceClass": "redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread"
                                                      }
                                                    ]
                                                  }
                                                }
                                              ]
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        },
        "IsMainSale": true
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.