DescribeAvailableZones - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the available resources in the zone in which an instance resides.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeAvailableZones	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. 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 of the instance. Valid values: 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 if you set Engine to MariaDB: 10.3 Serverless instances 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
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. NoteThe 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: 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 instances 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
RequestId	string	The ID of the request.	4256E149-C3C4-4FA7-BDEA-13CA415E8763
AvailableZones	object []	An array that consists of available zones and resources available in the zones.
ZoneId	string	The zone ID of the instance.	cn-hangzhou-e
RegionId	string	The region ID of the instance.	cn-hangzhou
SupportedEngines	object []	An array that consists of the database engines available in the zone.
Engine	string	The database engine of the instance.	MySQL
SupportedEngineVersions	object []	An array that consists of the database engine versions available in the zone.
Version	string	The database engine version of the instance.	8.0
SupportedCategorys	object []	An array that consists of the RDS editions available in the zone.
Category	string	The RDS edition of the instance.	HighAvailability
SupportedStorageTypes	object []	An array that consists of the storage types available in the zone.
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.