You can call the DescribeAvailableResource operation to query the resources that are available to a region.

The DescribeAvailableResource operation is no longer available. You can use the DescribeAvailableZones and DescribeAvailableClasses operations instead.

Note You can call the DescribeAvailableResource operation up to 20 times within 1 minute.

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

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeAvailableResource

The operation that you want to perform. Set the value to DescribeAvailableResource.

RegionIdStringNocn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

ZoneIdStringNocn-hangzhou-b

The zone ID of the instance.

InstanceChargeTypeStringYesPostpaid

The billing method of the instance. Valid values:

  • Prepaid: subscription
  • Postpaid: pay-as-you-go
EngineStringNoMySQL

The database engine of the instance. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
EngineVersionStringNo5.7

The database engine version of the instance. Valid values:

  • Valid values when you set the Engine parameter to MySQL: 5.5, 5.6, 5.7, and 8.0
  • Valid values when you set the Engine parameter to SQLServer: 2008r2, 2012, 2012_ent_ha, 2012_std_ha, 2012_web, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_ent, and 2019_ent
  • Valid values when you set the Engine parameter to PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, and 15.0
  • Valid values when you set the Engine parameter to MariaDB: 10.3
DBInstanceClassStringNords.mysql.s1.small

The instance type of the instance. For more information, see Primary ApsaraDB RDS instance types.

OrderTypeStringNoBUY

The type of the order. Set the value to BUY.

DBInstanceStorageTypeStringNolocal_ssd

The storage type of the instance. Valid values:

  • local_ssd: local SSD
  • cloud_ssd: standard SSD
  • cloud_essd: enhanced SSDs (ESSD) of performance level 1 (PL1)
  • cloud_essd2: ESSD of PL2
  • cloud_essd3: ESSD of PL3
CategoryStringNoBasic

The RDS edition of the instance. Valid values:

  • Basic: RDS Basic Edition
  • HighAvailability: RDS High-availability Edition
  • AlwaysOn: RDS Cluster Edition
  • Finance: RDS Enterprise Edition
DispenseModeIntegerNo0

Specifies whether to return the zones in which the single-zone deployment method is supported. Valid values:

  • 1: returns the zones.
  • 0: does not return the zones.

Default value: 0.

Note The single-zone deployment method allows you to deploy an instance that runs RDS Enterprise Edition in a single zone.

Response parameters

ParameterTypeExampleDescription
RequestIdStringA32E046E-2643-4B65-828D-23FEED4853A3

The ID of the request.

AvailableZonesArray of AvailableZone

An array that consists of zones in which resources are available.

AvailableZone
ZoneIdStringcn-hangzhou-b

The zone ID of the instance.

StatusStringEnable

Indicates whether the resources in the region can be purchased. Valid values:

  • Enable: The resources in the region can be purchased.
  • Disable: The resources in the region cannot be purchased.
RegionIdStringcn-hangzhou

The region ID of the instance.

SupportedEnginesArray of SupportedEngine

An array that consists of the database engines available in the zone.

SupportedEngine
EngineStringMySQL

The database engine that the instance runs.

SupportedEngineVersionsArray of SupportedEngineVersion

An array that consists of the database engine versions available in the zone.

SupportedEngineVersion
VersionString5.7

The version of the database engine that is run by the instance.

SupportedCategorysArray of SupportedCategory

An array that consists of available RDS editions.

SupportedCategory
CategoryStringHighAvailability

The RDS edition of the instance.

SupportedStorageTypesArray of SupportedStorageType

An array that consists of available storage types.

SupportedStorageType
StorageTypeStringlocal_ssd

The storage type of the instance.

AvailableResourcesArray of AvailableResource

An array that consists of available resources.

AvailableResource
StorageRangeString"{\"values\":[{\"max\":2000,\"min\":5,\"step\":5}]}"

The range of the storage capacity. The value consists of the maximum storage capacity, the minimum storage capacity, and the increment to increase the storage capacity.

DBInstanceClassStringrds.mysql.s1.small

The instance type of the instance.

DBInstanceStorageRangeObject

An array that consists of the ranges of storage capacity.

StepInteger5

The increment at which the storage capacity increases. Unit: GB.

MaxInteger2000

The maximum storage capacity that you can purchase. Unit: GB.

MinInteger5

The minimum storage capacity that you must purchase. Unit: GB.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=DescribeAvailableResource
&InstanceChargeType=Postpaid
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAvailableResourceResponse>
    <RequestId>A32E046E-2643-4B65-828D-23FEED4853A3</RequestId>
    <AvailableZones>
        <ZoneId>cn-hangzhou-b</ZoneId>
        <Status>Enable</Status>
        <RegionId>cn-hangzhou</RegionId>
        <SupportedEngines>
            <Engine>MySQL</Engine>
            <SupportedEngineVersions>
                <Version>5.7</Version>
                <SupportedCategorys>
                    <Category>HighAvailability</Category>
                    <SupportedStorageTypes>
                        <StorageType>local_ssd</StorageType>
                        <AvailableResources>
                            <StorageRange>"{\"values\":[{\"max\":2000,\"min\":5,\"step\":5}]}"</StorageRange>
                            <DBInstanceClass>rds.mysql.s1.small</DBInstanceClass>
                            <DBInstanceStorageRange>
                                <Step>5</Step>
                                <Max>2000</Max>
                                <Min>5</Min>
                            </DBInstanceStorageRange>
                        </AvailableResources>
                    </SupportedStorageTypes>
                </SupportedCategorys>
            </SupportedEngineVersions>
        </SupportedEngines>
    </AvailableZones>
</DescribeAvailableResourceResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A32E046E-2643-4B65-828D-23FEED4853A3",
  "AvailableZones" : [ {
    "ZoneId" : "cn-hangzhou-b",
    "Status" : "Enable",
    "RegionId" : "cn-hangzhou",
    "SupportedEngines" : [ {
      "Engine" : "MySQL",
      "SupportedEngineVersions" : [ {
        "Version" : "5.7",
        "SupportedCategorys" : [ {
          "Category" : "HighAvailability",
          "SupportedStorageTypes" : [ {
            "StorageType" : "local_ssd",
            "AvailableResources" : [ {
              "StorageRange" : "\"{\\\"values\\\":[{\\\"max\\\":2000,\\\"min\\\":5,\\\"step\\\":5}]}\"",
              "DBInstanceClass" : "rds.mysql.s1.small",
              "DBInstanceStorageRange" : {
                "Step" : 5,
                "Max" : 2000,
                "Min" : 5
              }
            } ]
          } ]
        } ]
      } ]
    } ]
  } ]
}

Error codes

HTTP status codeError codeError messageDescription
400ArticleNotFoundArticle not foundThe error message returned because no relevant articles are found.

For a list of error codes, see Service error codes.