Query available resources - API Reference| Alibaba Cloud Documentation Center

Note You can call this 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


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 to use in the region. Valid values: Prepaid: specifies to use subscription billing. Postpaid: specifies to use pay-as-you-go billing.
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. If the region contains more than one zone, separate them with colons (:).
Engine	String	No	MySQL	The database engine to purchase in the region. Valid values: MySQL SQLServer PostgreSQL PPAS MariaDB
EngineVersion	String	No	5.7	The version of the database engine to purchase in the region. Valid values: MySQL: 5.5 \| 5.6 \| 5.7 \| 8.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	The instance type to purchase in the region. For more information, see Primary instance types.
OrderType	String	No	BUY	The type of the purchase order. Set the value to BUY.
DBInstanceStorageType	String	No	local_ssd	The storage type to purchase in the region. Valid values: local_ssd/ephemeral_ssd: specifies to purchase local SSDs. cloud_ssd: specifies to purchase standard SSDs. cloud_essd: specifies to purchase enhanced SSDs.

Response parameters


Parameter	Type	Example	Description
RequestId	String	A32E046E-2643-4B65-828D-23FEED4853A3	The ID of the request.
AvailableZones	Array		An array that consists of available zones.
RegionId	String	cn-hangzhou	The ID of the region.
ZoneId	String	cn-hangzhou-b	The ID of the zone.
Status	String	Enable	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.
SupportedEngines	Array		An array that consists of available database engines.
Engine	String	MySQL	The database engine available.
SupportedEngineVersions	Array		An array that consists of available database engine versions.
Version	String	5.7	The database engine version available.
SupportedCategorys	Array		An array that consists of available RDS editions.
Category	String	HighAvailability	The RDS edition available.
SupportedStorageTypes	Array		An array that consists of available storage types.
StorageType	String	local_ssd	The storage type available.
AvailableResources	Array		An array that consists of available resources.
DBInstanceClass	String	rds.mysql.s1.small	The instance type available.
StorageRange	String	"{\"values\":[{\"max\":2000,\"min\":5,\"step\":5}]}"	The storage capacity range available, including the maximum capacity, minimum capacity, and incremental step.
DBInstanceStorageRange	Struct		An array that consists of available storage capacity ranges.
Max	Integer	2000	The maximum storage capacity available. Unit: GB.
Min	Integer	5	The minimum storage capacity available. Unit: GB.
Step	Integer	5	The incremental step of storage capacity. Unit: GB.

Examples

Sample requests

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

Sample success responses

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"
                        }
                    ]
                }
            }
        ]
    }
}

Error codes

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