全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Mar 30, 2023

    列出RDS可用区资源。

    调试

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

    调试

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

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

    		cn-hangzhou
    Enginestring是

    数据库类型。取值：

    • MySQL
    • SQLServer
    • PostgreSQL
    • MariaDB
    		MySQL
    ZoneIdstring否

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

    		cn-hangzhou-e
    EngineVersionstring否

    数据库版本。取值：

    • 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
    		8.0
    CommodityCodestring否

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

    • 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
    DispenseModestring否

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

    • 1：返回。
    • 0：不返回。

    默认值：0

    说明单可用区部署功能支持将三节点企业版实例安装到单个可用区中。
    		0
    DBInstanceNamestring否

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

    CommodityCode参数为如下值时必填：

    • rords_intl
    • rds_rordspre_public_intl
    • rords
    • rds_rordspre_public_cn
    		rm-uf6wjk5xxxxxxx
    Categorystring否

    实例系列，取值：

    • Basic：基础版

    • HighAvailability：高可用版

    • AlwaysOn：SQL Server集群版

    • Finance：三节点企业版

    • serverless_basic：Serverless基础版

    		HighAvailability

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求ID。

    		4256E149-C3C4-4FA7-BDEA-13CA415E8763
    AvailableZonesarray

    RDS可用区资源列表。

    object
    ZoneIdstring

    可用区ID。

    		cn-hangzhou-e
    RegionIdstring

    地域ID。

    		cn-hangzhou
    SupportedEnginesarray

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

    object
    Enginestring

    数据库类型。

    		MySQL
    SupportedEngineVersionsarray

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

    object
    Versionstring

    数据库版本。

    		8.0
    SupportedCategorysarray

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

    object
    Categorystring

    实例系列。

    		HighAvailability
    SupportedStorageTypesarray

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

    object
    StorageTypestring

    实例存储类型。

    		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错误码错误信息描述
    400ArticleNotFoundArticle not found没有找到相关约束
    404InvalidDBInstanceName.NotFoundDBInstanceName not found-

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