You can call the DescribeAvailableResource operation to query the resources that are available to a region.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeAvailableResource |
The operation that you want to perform. Set the value to DescribeAvailableResource. |
InstanceChargeType | String | Yes | Postpaid |
The billing method of the resources. Valid values:
|
RegionId | String | No | cn-hangzhou |
The ID of the region. You can call the DescribeRegions operation to query the most recent region list. |
ZoneId | String | No | cn-hangzhou-b |
The ID of the zone to which the resources belong. If you specify more than one zone ID, you can separate these zone IDs with colons (:). |
Engine | String | No | MySQL |
The database engine that is supported for the resources. Valid values:
|
EngineVersion | String | No | 5.7 |
The version of the database engine that is supported for the resources. Valid values:
|
DBInstanceClass | String | No | rds.mysql.s1.small |
The instance type of the resources. For more information, see Primary instance types. |
OrderType | String | No | BUY |
The type of order that is supported for the resources. Set the value to BUY. |
DBInstanceStorageType | String | No | local_ssd |
The type of storage media to query. Valid values:
|
Category | String | No | Basic |
The RDS edition that is supported for the resources. Valid values:
|
DispenseMode | Integer | No | 0 |
Specifies whether to return the zones in which the single-zone deployment method is supported. Valid values:
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
Parameter | Type | Example | Description |
---|---|---|---|
AvailableZones | Array of AvailableZone |
An array that consists of zones in which resources are available. |
|
AvailableZone | |||
RegionId | String | cn-hangzhou |
The ID of the region. |
Status | String | Enable |
Indicates whether the resources in the region can be purchased. Valid values:
|
SupportedEngines | Array of SupportedEngine |
An array that consists of available database engines. |
|
SupportedEngine | |||
Engine | String | MySQL |
The available database engine. |
SupportedEngineVersions | Array of SupportedEngineVersion |
An array that consists of the available database engine versions. |
|
SupportedEngineVersion | |||
SupportedCategorys | Array of SupportedCategory |
An array that consists of available RDS editions. |
|
SupportedCategory | |||
Category | String | HighAvailability |
The available RDS edition. |
SupportedStorageTypes | Array of SupportedStorageType |
An array that consists of available storage types. |
|
SupportedStorageType | |||
AvailableResources | Array of AvailableResource |
An array that consists of available resources. |
|
AvailableResource | |||
DBInstanceClass | String | rds.mysql.s1.small |
The available instance type. |
DBInstanceStorageRange | Struct |
An array that consists of the ranges of available storage capacity. |
|
Max | Integer | 2000 |
The maximum storage capacity that you can purchase. Unit: GB. |
Min | Integer | 5 |
The minimum storage capacity that you must purchase. Unit: GB. |
Step | Integer | 5 |
The increment at which the storage capacity increases. Unit: GB. |
StorageRange | String | "{\"values\":[{\"max\":2000,\"min\":5,\"step\":5}]}" |
The range of the available storage capacity. The range specifies the maximum and minimum storage capacities. The capacity can be adjusted at the specified increment. |
StorageType | String | local_ssd |
The available storage type. |
Version | String | 5.7 |
The database engine version that is available. |
ZoneId | String | cn-hangzhou-b |
The ID of the zone. |
RequestId | String | A32E046E-2643-4B65-828D-23FEED4853A3 |
The ID of the request. |
Examples
Sample requests
http(s)://rds.aliyuncs.com/?Action=DescribeAvailableResource
&InstanceChargeType=Postpaid
&<Common request parameters>
Sample success responses
XML
format
<RequestId>A32E046E-2643-4B65-828D-23FEED4853A3</RequestId>
<AvailableZones>
<AvailableZone>
<Status>Enable</Status>
<ZoneId>cn-hangzhou-b</ZoneId>
<RegionId>cn-hangzhou</RegionId>
<SupportedEngines>
<SupportedEngine>
<Engine>MySQL</Engine>
<SupportedEngineVersions>
<SupportedEngineVersion>
<Version>5.7</Version>
<SupportedCategorys>
<SupportedCategory>
<Category>HighAvailability</Category>
<SupportedStorageTypes>
<SupportedStorageType>
<StorageType>local_ssd</StorageType>
<AvailableResources>
<AvailableResource>
<DBInstanceClass>rds.mysql.s1.small</DBInstanceClass>
<StorageRange>"{\"values\":[{\"max\":2000,\"min\":5,\"step\":5}]}"</StorageRange>
<DBInstanceStorageRange>
<Min>5</Min>
<Max>2000</Max>
<Step>5</Step>
</DBInstanceStorageRange>
</AvailableResource>
</AvailableResources>
</SupportedStorageType>
</SupportedStorageTypes>
</SupportedCategory>
</SupportedCategorys>
</SupportedEngineVersion>
</SupportedEngineVersions>
</SupportedEngine>
</SupportedEngines>
</AvailableZone>
</AvailableZones>
JSON
format
{"RequestId":"A32E046E-2643-4B65-828D-23FEED4853A3","AvailableZones":{"AvailableZone":[{"Status":"Enable","ZoneId":"cn-hangzhou-b","RegionId":"cn-hangzhou","SupportedEngines":{"SupportedEngine":[{"Engine":"MySQL","SupportedEngineVersions":{"SupportedEngineVersion":[{"Version":"5.7","SupportedCategorys":{"SupportedCategory":[{"Category":"HighAvailability","SupportedStorageTypes":{"SupportedStorageType":[{"StorageType":"local_ssd","AvailableResources":{"AvailableResource":[{"DBInstanceClass":"rds.mysql.s1.small","StorageRange":"\"{\\\"values\\\":[{\\\"max\\\":2000,\\\"min\\\":5,\\\"step\\\":5}]}\"","DBInstanceStorageRange":{"Min":"5","Max":"2000","Step":"5"}}]}}]}}]}}]}}]}}]}}
Error codes
For a list of error codes, visit the API Error Center.