DescribeAvailableZones - 查询可用区资源 - 云数据库 RDS

该接口用于查询RDS的可用区资源。

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeAvailableZones	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域ID。可调用DescribeRegions获取。	cn-hangzhou
Engine	string	是	数据库类型。取值： MySQL SQLServer PostgreSQL MariaDB	MySQL
ZoneId	string	否	可用区ID。多可用区的格式与单可用区不同，包含`MAZ`字样，例如`cn-hangzhou-MAZ6(b,f)`、`cn-hangzhou-MAZ5(b,e,f)`。可以通过接口DescribeRegions查看可用区ID。	cn-hangzhou-e
EngineVersion	string	否	数据库版本。取值：常规实例 MySQL：5.5、5.6、5.7、8.0 SQL Server：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、2019_ent PostgreSQL：10.0、11.0、12.0、13.0、14.0、15.0 MariaDB：10.3 Serverless实例 MySQL：5.7、8.0 SQL Server：2016_std_sl、2017_std_sl、2019_std_sl PostgreSQL：14.0 说明MariaDB不支持创建Serverless实例。	8.0
CommodityCode	string	否	当前实例的商品码。根据输入的商品码查询可售卖的资源。取值： bards：主实例按量付费（中国站） rds：主实例包年包月（中国站） rords：只读实例按量付费（中国站） rds_rordspre_public_cn：只读实例包年包月（中国站） bards_intl：主实例按量付费（国际站） rds_intl：主实例包年包月（国际站） rords_intl：只读实例按量付费（国际站） rds_rordspre_public_intl：只读实例包年包月（国际站） rds_serverless_public_cn：serverless（中国站） rds_serverless_public_intl：serverless（国际站）	bards
DispenseMode	string	否	是否返回支持单可用区部署功能的可用区列表。取值： 1（默认值）：返回 0：不返回说明单可用区部署功能支持将三节点企业版实例安装到单个可用区中。	0
DBInstanceName	string	否	主实例ID。查询该主实例下可售卖的只读实例资源。 CommodityCode参数为如下值时必填： rords_intl rds_rordspre_public_intl rords rds_rordspre_public_cn	rm-uf6wjk5****
Category	string	否	实例系列，取值：常规实例 Basic：基础版 HighAvailability：高可用版 cluster：MySQL集群版 AlwaysOn：SQL Server集群版 Finance：三节点企业版 Serverless实例 serverless_basic：Serverless基础版（仅适用MySQL和PostgreSQL） serverless_standard：MySQL Serverless高可用版 serverless_ha：SQL Server Serverless高可用版	HighAvailability

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
RequestId	string	请求ID。	4256E149-C3C4-4FA7-BDEA-13CA415E8763
AvailableZones	object []	RDS可用区资源列表。
ZoneId	string	可用区ID。	cn-hangzhou-e
RegionId	string	地域ID。	cn-hangzhou
SupportedEngines	object []	支持售卖的数据库类型列表。
Engine	string	数据库类型。	MySQL
SupportedEngineVersions	object []	支持售卖的数据库版本列表。
Version	string	数据库版本。	8.0
SupportedCategorys	object []	支持售卖的数据库系列列表。
Category	string	实例系列。	HighAvailability
SupportedStorageTypes	object []	支持售卖的存储类型列表。
StorageType	string	实例存储类型。	local_ssd

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	ArticleNotFound	Article not found	没有找到相关约束
404	InvalidDBInstanceName.NotFound	DBInstanceName not found	-

访问错误中心查看更多错误码。