You can call the DescribeAvailableResource operation to query the resources that are available to a region.
This operation will no longer be available. You can use the DescribeAvailableZones and DescribeAvailableClasses operations instead.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeAvailableResource |
The operation that you want to perform. Set the value to DescribeAvailableResource. |
RegionId | String | No | cn-hangzhou |
The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. |
ZoneId | String | No | cn-hangzhou-b |
The zone ID of the instance. If the instance is deployed in multiple zones, you must separate the IDs of the zones with colons (:). |
InstanceChargeType | String | Yes | Postpaid |
The billing method of the instance. Valid values:
|
Engine | String | No | MySQL |
The database engine of the instance. Valid values:
|
EngineVersion | String | No | 5.7 |
The database engine version of the instance. Valid values:
|
DBInstanceClass | String | No | rds.mysql.s1.small |
The instance type of the instance. For more information, see Primary ApsaraDB RDS instance types. |
OrderType | String | No | BUY |
The type of the order. Set the value to BUY. |
DBInstanceStorageType | String | No | local_ssd |
The storage type of the instance. Valid values:
|
Category | String | No | Basic |
The RDS edition of the instance. 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 |
---|---|---|---|
RequestId | String | A32E046E-2643-4B65-828D-23FEED4853A3 |
The ID of the request. |
AvailableZones | Array of AvailableZone |
An array that consists of zones in which resources are available. |
|
AvailableZone | |||
ZoneId | String | cn-hangzhou-b |
The zone ID of the instance. |
Status | String | Enable |
Indicates whether the resources in the region can be purchased. Valid values:
|
RegionId | String | cn-hangzhou |
The region ID of the instance. |
SupportedEngines | Array of SupportedEngine |
An array that consists of the database engines available in the zone. |
|
SupportedEngine | |||
Engine | String | MySQL |
The database engine of the instance. |
SupportedEngineVersions | Array of SupportedEngineVersion |
An array that consists of the database engine versions available in the zone. |
|
SupportedEngineVersion | |||
Version | String | 5.7 |
The database engine version of the instance. |
SupportedCategorys | Array of SupportedCategory |
An array that consists of available RDS editions. |
|
SupportedCategory | |||
Category | String | HighAvailability |
The RDS edition of the instance. |
SupportedStorageTypes | Array of SupportedStorageType |
An array that consists of available storage types. |
|
SupportedStorageType | |||
StorageType | String | local_ssd |
The storage type of the instance. |
AvailableResources | Array of AvailableResource |
An array that consists of available resources. |
|
AvailableResource | |||
StorageRange | String | "{\"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. |
DBInstanceClass | String | rds.mysql.s1.small |
The instance type of the instance. |
DBInstanceStorageRange | Object |
An array that consists of the ranges of storage capacity. |
|
Step | Integer | 5 |
The increment at which the storage capacity increases. Unit: GB. |
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. |
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
<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
HTTP/1.1 200 OK
Content-Type:application/json
{
"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.