文档

DescribeAvailabilityZones - 查看实例支持的可用区

更新时间:

查询MongoDB实例支持的可用区列表。

接口说明

查询给定购买条件下,支持的 MongoDB 可用区列表。购买条件中,地域 ID 必填。

调试

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

授权信息

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

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

请求参数

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

地域 ID,您可以调用 DescribeRegions 查询。

cn-hangzhou
ZoneIdstring

可用区 ID,您可以通过调用 DescribeRegions 查询。

cn-hangzhou-b
InstanceChargeTypestring

付费类型。取值:

  • PrePaid(默认值):包年包月。
  • PostPaid:按量付费。
PrePaid
DbTypestring

实例的数据库类型。取值:

  • normal:副本集实例。
  • sharding:分片集群实例。
normal
ResourceGroupIdstring

资源组 ID。资源组详情请参见查看资源组基本信息

rg-acfmx2m4rqu7pry
AcceptLanguagestring

指定返回参数 RegionNameZoneName 的语言,取值说明:

  • zh:默认值,中文。
  • en:英文。
zh
StorageSupportstring

存储类型:

  • cloud:仅展示支持云盘版实例的可用区。
  • local:仅展示支持本地盘版实例的可用区。
  • default 或空:展示本地盘和云盘版实例都支持的可用区。
local
MongoTypestring

高可用版还是测试版(dbfs)

dbfs
StorageTypestring

存储类型,取值说明:

  • cloud_essd1:ESSD PL1 云盘。
  • cloud_essd2:ESSD PL2 云盘。
  • cloud_essd3:ESSD PL3 云盘。
  • local_ssd:SSD 本地盘。
说明
  • 4.4 及以上版本实例只支持云盘,不填写默认选择cloud_essd1
  • 4.2 及以下版本实例只支持本地盘,不填写默认选择local_ssd
  • local_ssd
    ExcludeZoneIdstring

    当前地域过滤此输入的可用区查询结果。

    cn-shanghai-g
    ExcludeSecondaryZoneIdstring

    当前地域过滤此输入的可用区查询结果,结合“ExcludeZoneId”实现多可用区过滤。

    cn-shanghai-b
    DBInstanceClassstring

    实例规格。

    dds.mongo.standard
    EngineVersionstring

    数据库版本号。

    5.0
    ReplicationFactorstring

    节点数。

    说明 该参数仅支持副本集实例。
    枚举值:
    • 11
    • 33
    • 55
    • 77
    3

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    19A13A33-0FAD-5120-8AE1-B1636F74DD80
    AvailableZonesobject []

    支持购买的可用区资源详情。

    ZoneIdstring

    可用区 ID。

    cn-beijing-f
    ZoneNamestring

    可用区名称。

    根据 AcceptLanguage 参数的值返回不同的语言。以cn-hangzhou-h可用区为例,示例如下:

    • AcceptLanguagezh杭州 可用区 H
    • AcceptLanguageenHangzhou Zone H
    杭州 可用区H
    RegionIdstring

    地域 ID。您可以通过调用 DescribeRegions 接口查询。

    cn-beijing

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "19A13A33-0FAD-5120-8AE1-B1636F74DD80",
      "AvailableZones": [
        {
          "ZoneId": "cn-beijing-f",
          "ZoneName": "杭州 可用区H",
          "RegionId": "cn-beijing"
        }
      ]
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-12-27OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:ReplicationFactor
    2023-11-03OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:DBInstanceClass
      新增入参:EngineVersion
    • 本页导读 (1)
    文档反馈