All Products
Search
Document Center

ApsaraDB RDS:DescribeAvailableZones

Last Updated:Jan 16, 2024

Queries the available zones for an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
EnginestringYes

The database engine of the instance. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
MySQL
ZoneIdstringNo

The zone ID of the instance. If the instance spans more than one zone, the value of this parameter contains an MAZ part, such as 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.

cn-hangzhou-e
EngineVersionstringNo

The database engine version. Valid values:

  • Regular instance

    • Valid values if you set Engine to MySQL: 5.5, 5.6, 5.7, and 8.0
    • Valid values if you set Engine to SQLServer: 2008r2, 08r2_ent_ha, 2012, 2012_ent_ha, 2012_std_ha, 2012_web, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_std_ha, 2017_ent, 2019_std_ha, and 2019_ent
    • Valid values if you set Engine to PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, and 15.0
    • Valid value when you set Engine to MariaDB: 10.3
  • Serverless instance

    • Valid values if you set Engine to MySQL: 5.7 and 8.0
    • Valid values if you set Engine to SQLServer: 2016_std_sl, 2017_std_sl, and 2019_std_sl
    • Valid value if you set Engine to PostgreSQL: 14.0

    **

    NoteApsaraDB RDS for MariaDB does not support serverless instances.

8.0
CommodityCodestringNo

The commodity code of the instance. This operation can return the resources that you can purchase based on the specified commodity code. Valid values:

  • bards: The instance is a pay-as-you-go primary instance. This value is available at the China site (aliyun.com).
  • rds: The instance is a subscription primary instance. This value is available at the China site (aliyun.com).
  • rords: The instance is a pay-as-you-go read-only instance. This value is available at the China site (aliyun.com).
  • rds_rordspre_public_cn: The instance is a subscription read-only instance. This value is available at the China site (aliyun.com).
  • bards_intl: The instance is a pay-as-you-go primary instance. This value is available at the International site (alibabacloud.com).
  • rds_intl: The instance is a subscription primary instance. This value is available at the International site (alibabacloud.com).
  • rords_intl: The instance is a pay-as-you-go read-only instance. This value is available at the International site (alibabacloud.com).
  • rds_rordspre_public_intl: The instance is a subscription read-only instance. This value is available at the International site (alibabacloud.com).
  • rds_serverless_public_cn: The instance is a serverless instance. This value is available at the China site (aliyun.com).
  • rds_serverless_public_intl: The instance is a serverless instance. This value is available at the International site (alibabacloud.com).
bards
DispenseModestringNo

Specifies whether to return the zones in which the single-zone deployment method is supported. Valid values:

  • 1 (default): returns the zones.
  • 0: does not return the zones.
Note The single-zone deployment method allows you to deploy an instance that runs RDS Enterprise Edition in a single zone.
0
DBInstanceNamestringNo

The ID of the primary instance. If you want to query the read-only instances that you can purchase for a primary instance, you can specify this parameter.

If you set CommodityCode to one of the following values, you must specify this parameter:

  • rords_intl
  • rds_rordspre_public_intl
  • rords
  • rds_rordspre_public_cn
rm-uf6wjk5xxxxxxx
CategorystringNo

The RDS edition of the instance. Valid values:

  • Regular instance

    • Basic: RDS Basic Edition.
    • HighAvailability: RDS High-availability Edition.
    • cluster: RDS Cluster Edition for ApsaraDB RDS for MySQL.
    • AlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server.
    • Finance: RDS Enterprise Edition.
  • Serverless instance

    • serverless_basic: RDS Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL.
    • serverless_standard: RDS High-availability Edition for ApsaraDB RDS for MySQL.
    • serverless_ha: RDS High-availability Edition for ApsaraDB RDS for SQL Server.
HighAvailability

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

4256E149-C3C4-4FA7-BDEA-13CA415E8763
AvailableZonesobject []

The available zones in the region.

ZoneIdstring

The zone ID.

cn-hangzhou-e
RegionIdstring

The region ID.

cn-hangzhou
SupportedEnginesobject []

The database engines that are available for purchase.

Enginestring

The database engine of the instance.

MySQL
SupportedEngineVersionsobject []

The database engine versions that are available for purchase.

Versionstring

The database engine version.

8.0
SupportedCategorysobject []

The RDS editions that are available that are available for purchase.

Categorystring

The RDS edition of the instance.

HighAvailability
SupportedStorageTypesobject []

The storage types that are available for purchase.

StorageTypestring

The storage type of the instance.

local_ssd

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400ArticleNotFoundArticle not foundNo relevant constraints are found.
404InvalidDBInstanceName.NotFoundDBInstanceName not found-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history