调用DescribeAvailableZones接口列出RDS可用区资源。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAvailableZones

系统规定参数。取值:DescribeAvailableZones

RegionId String cn-hangzhou

地域ID。可以通过接口DescribeRegions查看可用的地域ID。

Engine String MySQL

数据库类型。取值:

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

可用区ID。多可用区的格式与单可用区不同,包含MAZ字样,例如cn-hangzhou-MAZ6(b,f)cn-hangzhou-MAZ5(b,e,f)。可以通过接口DescribeRegions查看可用区ID。

EngineVersion String 8.0

数据库版本。取值:

  • 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_ent
  • PostgreSQL:9.4/10.0/11.0/12.0
  • PPAS:9.3/10.0
  • MariaDB:10.3
CommodityCode String bards

当前实例的商品码。根据输入的商品码查询可售卖的资源。取值:

  • bards:主实例按量付费(中国站)
  • rds:主实例包年包月(中国站)
  • rords:只读实例按量付费(中国站)
  • rds_rordspre_public_cn:只读实例包年包月(中国站)
  • bards_intl:主实例按量付费(国际站)
  • rds_intl:主实例包年包月(国际站)
  • rords_intl:只读实例按量付费(国际站)
  • rds_rordspre_public_intl:只读实例包年包月(国际站)
DispenseMode String 0

是否返回支持单可用区部署功能的可用区列表。取值:

  • 1:返回。
  • 0:不返回。

    默认值:0

说明 单可用区部署功能支持将三节点企业版实例安装到单个可用区中。
DBInstanceName String rm-uf6wjk5xxxxxxx

主实例ID。查询该主实例下可售卖的只读实例资源。

CommodityCode参数为如下值时必填:

  • rords_intl
  • rds_rordspre_public_intl
  • rords
  • rds_rordspre_public_cn

返回数据

名称 类型 示例值 描述
AvailableZones Array of AvailableZone

RDS可用区资源列表。

RegionId String cn-hangzhou

地域ID。

SupportedEngines Array of SupportedEngine

支持售卖的数据库类型列表。

Engine String MySQL

数据库类型。

SupportedEngineVersions Array of SupportedEngineVersion

支持售卖的数据库版本列表。

SupportedCategorys Array of SupportedCategory

支持售卖的数据库系列列表。

Category String HighAvailability

实例系列。

SupportedStorageTypes Array of SupportedStorageType

支持售卖的存储类型列表。

StorageType String local_ssd

实例存储类型。

Version String 8.0

数据库版本。

ZoneId String cn-hangzhou-e

可用区ID。

RequestId String 4256E149-C3C4-4FA7-BDEA-13CA415E8763

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeAvailableZones
&RegionId=cn-hangzhou
&Engine=MySQL
&ZoneId=cn-hangzhou-e
&EngineVersion=8.0
&<公共请求参数>

正常返回示例

XML格式

<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格式

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

错误码

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