备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 RDS 开发参考 API参考 API目录 实例 DescribeAvailableZones - 查询可用区资源

DescribeAvailableZones - 查询可用区资源

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

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

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
    说明 该接口仅用于查询可用区资源，不用于控制台关于 RDS PostgreSQL 的售卖。购买页根据实际售卖策略不同，部分参数取值会略有不同，实际购买时请以购买页为准。
  • RDS SQL Server
  • RDS MariaDB

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

地域 ID。可调用 DescribeRegions 获取。

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
  • Serverless 实例

    • MySQL：5.7、8.0

    • SQL Server：2016_std_sl、2017_std_sl、2019_std_sl

    • PostgreSQL：14.0

    说明 MariaDB 不支持创建 Serverless 实例。
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
DBInstanceNamestring否

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

CommodityCode 参数为如下值时必填：

  • rords_intl
  • rds_rordspre_public_intl
  • rords
  • rds_rordspre_public_cn
rm-uf6wjk5****
Categorystring否

实例系列，取值：

  • 常规实例
    • 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

返回参数详情。

RequestIdstring

请求 ID。

4256E149-C3C4-4FA7-BDEA-13CA415E8763
AvailableZonesobject []

RDS 可用区资源列表。

ZoneIdstring

可用区 ID。

cn-hangzhou-e
RegionIdstring

地域 ID。

cn-hangzhou
SupportedEnginesobject []

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

Enginestring

数据库类型。

MySQL
SupportedEngineVersionsobject []

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

Versionstring

数据库版本。

8.0
SupportedCategorysobject []

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

Categorystring

实例系列。

HighAvailability
SupportedStorageTypesobject []

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

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没有找到相关约束
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0，请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法，请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题，请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单，请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善，请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常，详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整，请在操作前填写您的信息。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单，请支付后重试。
404InvalidDBInstanceName.NotFoundDBInstanceName not found-

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

变更历史

变更时间变更内容概要操作
暂无变更历史
文档推荐
  • 本页导读 （1）
文档反馈