You can call DescribeAvailableResource to query the types of ApsaraDB for Redis instances that can be created in a specified zone.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeAvailableResource

The operation that you want to perform. Set this parameter to DescribeAvailableResource.

RegionId String Yes cn-beijing

The ID of the region. You can call the DescribeRegions operation to query the latest region list.

ZoneId String No cn-beijing-c

The ID of the zone. You can call the DescribeZones operation to query the zone ID.

InstanceChargeType String No PrePaid

The payment type. Valid values:

  • PrePaid: subscription.
  • PostPaid: pay-as-you-go.
Note Default value: PrePaid.
Engine String No redis

The engine type. Valid values:

  • redis
  • memcache

Response parameters

Parameter Type Example Description
AvailableZones Array

The detailed information of ApsaraDB for Redis instances that can be created in the zone.

AvailableZone
RegionId String cn-beijing

The ID of the region.

SupportedEngines Array

The engine types that are supported.

SupportedEngine
Engine String ApsaraDB for Redis

The engine type of the instance.

SupportedEditionTypes Array

Supported Editions.

SupportedEditionType
EditionType String Community

Edition:

  • Community
  • Enterprise
SupportedSeriesTypes Array

Supported types of the series.

SupportedSeriesType
SeriesType String enhanced_performance_type

Series:

  • enhanced_performance_type: indicates performance-enhanced series.
  • hybrid_storage: indicates hybrid-storage series.
SupportedEngineVersions Array

The engine version list.

SupportedEngineVersion
SupportedArchitectureTypes Array

Supported architecture types.

SupportedArchitectureType
Architecture String cluster

Architecture:

  • standard: the standard master-replica edition.
  • cluster: the cluster edition.
  • rwsplit: the read/write-splitting edition.
SupportedShardNumbers Array

Number of shards supported.

SupportedShardNumber
ShardNumber String 8

The number of shards.

SupportedNodeTypes Array

Supported node types.

SupportedNodeType
AvailableResources Array

The detailed information about available instance types in the zone.

AvailableResource
InstanceClass String redis.logic.sharding.2g.8db.0rodb.8proxy.default

The specification code. In the Help Center, enter an instance type code in the search box to view the instance type information.

InstanceClassRemark String 16 GB Cluster Edition (Sharding)(QPS:2000000 Connections:80000)

The description of the instance type.

SupportedNodeType String double

The node type of the instance. Valid values:

  • single: single-node.
  • double: master-replica.
Version String 5.0

The engine version of the instance.

ZoneId String cn-beijing-c

The ID of the zone.

ZoneName String Beijing Zone C

The name of the zone.

RequestId String 128BD75D-A423-4235-B777-811429BB6E4D

The ID of the request.

Examples

Sample request

https://r-kvstore.aliyuncs.com
?Action=DescribeAvailableResource
&RegionId=cn-beijing
&ZoneId=cn-beijing-c
&<Common request parameters>

Sample success responses

XML format

<DescribeAvailableResourceResponse>
    <RequestId>5094D428-5CC5-4494-A8B4-59BBBDEDABF5</RequestId>
    <AvailableZones>
          <AvailableZone>
                <ZoneName> Beijing Zone C</ZoneName>
                <ZoneId>cn-beijing-c</ZoneId>
                <SupportedEngines>
                      <SupportedEngine>
                            <SupportedEditionTypes>
                                  <SupportedEditionType>
                                        <EditionType>Community</EditionType>
                                        <SupportedSeriesTypes>
                                              <SupportedSeriesType>
                                                    <SupportedEngineVersions>
                                                          <SupportedEngineVersion>
                                                                <SupportedArchitectureTypes>
                                                                      <SupportedArchitectureType>
                                                                            <SupportedShardNumbers>
                                                                                  <SupportedShardNumber>
                                                                                        <ShardNumber>8</ShardNumber>
                                                                                        <SupportedNodeTypes>
                                                                                              <SupportedNodeType>
                                                                                                    <AvailableResources>
                                                                                                          <AvailableResource>
                                                                                                              <InstanceClass> redis.logic.sharding.2g.8db.0rodb.8proxy.default</InstanceClass>
                                                                                                              <InstanceClassRemark>16 GB Cluster Edition (Sharding)(QPS:2000000 Connections:80000)</InstanceClassRemark>
                                                                                                          </AvailableResource>
                                                                                                    </AvailableResources>
                                                                                                    <SupportedNodeType>double</SupportedNodeType>
                                                                                              </SupportedNodeType>
                                                                                        </SupportedNodeTypes>
                                                                                  </SupportedShardNumber>
                                                                            </SupportedShardNumbers>
                                                                            <Architecture>cluster</Architecture>
                                                                      </SupportedArchitectureType>
                                                                </SupportedArchitectureTypes>
                                                                <Version>5.0</Version>
                                                          </SupportedEngineVersion>
                                                    </SupportedEngineVersions>
                                                    <SeriesType>enhanced_performance_type</SeriesType>
                                              </SupportedSeriesType>
                                        </SupportedSeriesTypes>
                                  </SupportedEditionType>
                            </SupportedEditionTypes>
                            <Engine>redis</Engine>
                      </SupportedEngine>
                </SupportedEngines>
          </AvailableZone>
    </AvailableZones>
</DescribeAvailableResourceResponse>

JSON format

{
    "RequestId": "5094D428-5CC5-4494-A8B4-59BBBDEDABF5",
    "AvailableZones": {
        "AvailableZone": {
            "ZoneName": "Beijing Zone C",
            "ZoneId": "cn-beijing-c",
            "SupportedEngines": {
                "SupportedEngine": {
                    "SupportedEditionTypes": {
                        "SupportedEditionType": {
                            "EditionType": "Community",
                            "SupportedSeriesTypes": {
                                "SupportedSeriesType": {
                                    "SupportedEngineVersions": {
                                        "SupportedEngineVersion": {
                                            "SupportedArchitectureTypes": {
                                                "SupportedArchitectureType": {
                                                    "SupportedShardNumbers": {
                                                        "SupportedShardNumber": {
                                                            "ShardNumber": 8,
                                                            "SupportedNodeTypes": {
                                                                "SupportedNodeType": {
                                                                    "AvailableResources": {
                                                                        "AvailableResource": {
                                                                            "InstanceClass": "redis.logic.sharding.2g.8db.0rodb.8proxy.default",
                                                                            "InstanceClassRemark": "16 GB Cluster Edition (Sharding)(QPS:2000000 Connections:80000)"
                                                                        }
                                                                    },
                                                                    "SupportedNodeType": "double"
                                                                }
                                                            }
                                                        }
                                                    },
                                                    "Architecture": "cluster"
                                                }
                                            },
                                            "Version": 5
                                        }
                                    },
                                    "SeriesType": "enhanced_performance_type"
                                }
                            }
                        }
                    },
                    "Engine": "redis"
                }
            }
        }
    }
}

Error codes

For a list of error codes, visit the API Error Center.