DescribeAvailableZones - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the available zones for an instance.

Operation Description

Supported database engines

MySQL
PostgreSQL
SQL Server
MariaDB

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Engine	string	Yes	The database engine of the instance. Valid values: MySQL SQLServer PostgreSQL MariaDB	MySQL
ZoneId	string	No	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
EngineVersion	string	No	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 Note**ApsaraDB RDS for MariaDB does not support serverless instances.	8.0
CommodityCode	string	No	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
DispenseMode	string	No	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
DBInstanceName	string	No	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
Category	string	No	The RDS edition of the instance. Valid values: Regular instance Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition cluster: RDS Cluster Edition for MySQL AlwaysOn: RDS Cluster Edition for SQL Server Finance: RDS Enterprise Edition Serverless instance serverless_basic: RDS Serverless Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL. serverless_standard: RDS Serverless High-availability Edition for MySQL. serverless_ha RDS Serverless High-availability Edition for SQL Server.	HighAvailability

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	4256E149-C3C4-4FA7-BDEA-13CA415E8763
AvailableZones	object []	The available zones in the region.
ZoneId	string	The zone ID.	cn-hangzhou-e
RegionId	string	The region ID.	cn-hangzhou
SupportedEngines	object []	The database engines that are available for purchase.
Engine	string	The database engine of the instance.	MySQL
SupportedEngineVersions	object []	The database engine versions that are available for purchase.
Version	string	The database engine version.	8.0
SupportedCategorys	object []	The RDS editions that are available that are available for purchase.
Category	string	The RDS edition of the instance.	HighAvailability
SupportedStorageTypes	object []	The storage types that are available for purchase.
StorageType	string	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 code	Error code	Error message	Description
400	ArticleNotFound	Article not found	No relevant constraints are found.
404	InvalidDBInstanceName.NotFound	DBInstanceName not found	-

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

Change history

Change time	Summary of changes	Operation

No change history