Queries the available resources in a region.

Note You can call this API action up to 20 times within one minute.

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

ID Type Required Example value Description
Action String Yes DescribeAvailableResource The name of this API action. Value: DescribeAvailableResource.
InstanceChargeType String Yes Postpaid

The billing method. Valid values:

  • Prepaid: subscription billing.
  • Postpaid: pay-as-you-go billing.
RegionId String No cn-hangzhou

The ID of the region to which the RDS instance belongs. You can call the DescribeRegions API action to obtain this region ID.

ZoneId String No cn-hangzhou-b

The ID of the zone to which the RDS instance belongs. If the RDS instance is deployed in multiple zones, separate the zone IDs by using colons (:).

Engine String No MySQL

The used DB engine. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • PPAS
  • MariaDB
EngineVersion String No 5.7

The used DB engine version. Valid values:

  • MySQL: 5.5 | 5.6 | 5.7 | SQL8.0.
  • SQL Server: 2008r2 | 2012 | 2012_ent_ha | 2012_std_ha | 2012_web | 2016_ent_ha | 2016_std_ha | 2016_web | 2017_ent.
  • PostgreSQL: 9.4 | 10.0.
  • PPAS: 9.3 | 10.0.
  • MariaDB: 10.3.
DBInstanceClass String No rds.mysql.s1.small For more information about the instance types, see Instance types.
OrderType String No BUY The order type. Value: BUY.

Response elements

ID Type Example value Description
AvailableZones N/A None The list of available resources.
RegionId String cn-hangzhou The ID of the region to which the RDS instance belongs.
Status String Enable Whether resources be sold in the region. Values: Enable | Disable.
SupportedEngines N/A None The list of available database engines.
Engine String MySQL The used DB engine.
SupportedEngineVersions N/A None The list of available DB engine versions.
SupportedCategorys N/A None The list of available DB engine editions.
Category String HighAvailability The DB engine edition of the RDS instance.
SupportedStorageTypes N/A None The list of available storage types.
AvailableResources N/A None The list of available resources.
DBInstanceClass String rds.mysql.s1.small The type of the RDS instance.
DBInstanceStorageRange N/A None The list of available storage capacity ranges.
Max Integer 2000 The maximum storage capacity that is available. Unit: GB.
Min Integer 5 The minimum storage capacity that is available. Unit: GB.
Step Integer 5 The step at which the storage capacity increases. Unit: GB.
StorageRange String "{\"values\":[{\"max\":2000,\"min\":5,\"step\":5}]}" The storage capacity range that is available, including the maximum storage capacity, minimum storage capacity, and increase step.
StorageType String local_ssd The used storage type.
Version String 5.7 The used DB engine version.
ZoneId String cn-hangzhou-b The ID of the zone to which the RDS instance is located.
RequestId String A32E046E-2643-4B65-828D-23FEED4853A3 The ID of the request.

Examples

Request example:


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

Response example:

XML format: 

<DescribeAvailableResourceResponse>
  <RequestId>A32E046E-2643-4B65-828D-23FEED4853A3</RequestId>
	  <AvailableZones>
		    <AvailableZone>
			      <Status>Enable</Status>
			      <RegionId>cn-hangzhou</RegionId>
			      <ZoneId>cn-hangzhou-b</ZoneId>
			      <SupportedEngines>
				        <SupportedEngine>
					          <SupportedEngineVersions>
						            <SupportedEngineVersion>
							              <Version>5.6</Version>
							              <SupportedCategorys>
								                <SupportedCategory>
									                  <Category>HighAvailability</Category>
									                  <SupportedStorageTypes>
										                    <SupportedStorageType>
											                      <AvailableResources>
												                        <AvailableResource>
													                          <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>
												                        </AvailableResource>
											                      </AvailableResources>
											                      <StorageType>local_ssd</StorageType>
										                    </SupportedStorageType>
									                  </SupportedStorageTypes>
								                </SupportedCategory>
							              </SupportedCategorys>
						            </SupportedEngineVersion>
					          </SupportedEngineVersions>
					          <Engine>MySQL</Engine>
				        </SupportedEngine>
			      </SupportedEngines>
		    </AvailableZone>
	  </AvailableZones>
</DescribeAvailableResourceResponse>

JSON format: 

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

Errors

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