You can call this operation to list available zones resources of an ApsaraDB for RDS instance in a zone.

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

Name Type Required Example Description
Action String Yes DescribeAvailableZones

The operation that you want to perform. the value to DescribeAvailableZones.

RegionId String Yes cn-hangzhou

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

Engine String Yes MySQL

The database engine that the RDS instance runs. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • PPAS
  • MariaDB
ZoneId String No cn-hangzhou-e

The ID of the zone. If the instance spans more than one zone, the value of this parameter contains an MAZ part, for example, cn-hangzhou-MAZ6(b,f) and cn-hangzhou-MAZ5(b,e,f). You can call the DescribeRegions operation to query the most recent zone list.

EngineVersion String No 8.0

The version of the database engine that the instance runs. Valid values:

  • MySQL: 5.5 | 5.6 | 5.7 | 8.0
  • SQL Server:2008 r2 | 08r2_ent_ha | 2012 | 2012_ent_ha | 2012_std_ha | 2012_web | 2016_ent_ha | 2016_std_ha | 2016_web | 2017_std_ha | 2017_ent | 2019_ent
  • PostgreSQL: 9.4 | 10.0 | 11.0 | 12.0
  • PPAS: 9.3 | 10.0
  • MariaDB: 10.3
InstanceChargeType String No 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.

Response parameters

Parameter Type Example Description
AvailableZones Array

The zone resource list of the RDS instance.
RegionId String cn-hangzhou

The ID of the region.
SupportedEngines Array

The list of available database engines.
Engine String MySQL

The database engine that the RDS instance runs.
SupportedEngineVersions Array

The list of available database engine versions.
SupportedCategorys Array

The list of available database editions.
Category String HighAvailability

The edition of the instance.
SupportedStorageTypes Array

The list of available storage types.
StorageType String local_ssd

The storage type of the instance.
Version String 8.0

The version of the database engine that the RDS instance runs.
ZoneId String cn-hangzhou-e

The ID of the zone.
RequestId String Cost

The ID of the request.

Examples

Sample requests

http(s)://rds.aliyuncs.com/? Action=DescribeAvailableZones
&RegionId=cn-hangzhou
&Engine=MySQL
&ZoneId=cn-hangzhou-e
&EngineVersion=8.0
&<Common request parameters>

Sample success responses

XML format 

<DescribeAvailableZonesResponse>
  <RequestId>4256E149-C3C4-4FA7-BDEA-13CA415E8763</RequestId>
  <AvailableZones>
        <ZoneId>cn-hangzhou-e</ZoneId>
        <RegionId>cn-hangzhou</RegionId>
        <SupportedEngines>
              <SupportedEngineVersions>
                    <Version>8.0</Version>
                    <SupportedCategorys>
                          <Category>HighAvailability</Category>
                          <SupportedStorageTypes>
                                <StorageType>local_ssd</StorageType>
                          </SupportedStorageTypes>
                          <SupportedStorageTypes>
                                <StorageType>cloud_ssd</StorageType>
                          </SupportedStorageTypes>
                    </SupportedCategorys>
                    <SupportedCategorys>
                          <Category>Basic</Category>
                          <SupportedStorageTypes>
                                <StorageType>cloud_ssd</StorageType>
                          </SupportedStorageTypes>
                    </SupportedCategorys>
              </SupportedEngineVersions>
              <Engine>MySQL</Engine>
        </SupportedEngines>
  </AvailableZones>
</DescribeAvailableZonesResponse>

JSON format 

{
    "RequestId": "4256E149-C3C4-4FA7-BDEA-13CA415E8763",
    "AvailableZones": [
        {
            "ZoneId": "cn-hangzhou-e",
            "RegionId": "cn-hangzhou",
            "SupportedEngines": [
                {
                    "SupportedEngineVersions": [
                        {
                            "Version": "8.0",
                            "SupportedCategorys": [
                                {
                                    "Category": "HighAvailability",
                                    "SupportedStorageTypes": [
                                        {
                                            "StorageType": "local_ssd"
                                        },
                                        {
                                            "StorageType": "cloud_ssd"
                                        }
                                    ]
                                },
                                {
                                    "Category": "Basic",
                                    "SupportedStorageTypes": [
                                        {
                                            "StorageType": "cloud_ssd"
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "Engine": "MySQL"
                }
            ]
        }
    ]
}

Error codes

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