使用DescribeAvailabilityZones查询可用区列表-云数据库 MongoDB 版-阿里云

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

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeAvailabilityZones

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID，您可以调用 DescribeRegions 查询。	cn-hangzhou
ZoneId	string	否	可用区 ID，您可以通过调用 DescribeRegions 查询。	cn-hangzhou-b
InstanceChargeType	string	否	付费类型。取值： PrePaid（默认值）：包年包月。 PostPaid：按量付费。	PrePaid
DbType	string	否	实例的数据库类型。取值： normal：副本集实例。 sharding：分片集群实例。	normal
ResourceGroupId	string	否	资源组 ID。资源组详情请参见查看资源组基本信息。	rg-acfmx2m4rqu7pry
AcceptLanguage	string	否	指定返回参数 RegionName 和 ZoneName 的语言，取值说明： zh：默认值，中文。 en：英文。	zh
StorageSupport	string	否	存储类型： cloud：仅展示支持云盘版实例的可用区。 local：仅展示支持本地盘版实例的可用区。 default 或空：展示本地盘和云盘版实例都支持的可用区。	local
MongoType	string	否	高可用版还是测试版（dbfs）	dbfs
StorageType	string	否	存储类型，取值说明： 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
ExcludeZoneId	string	否	当前地域过滤此输入的可用区查询结果。	cn-shanghai-g
ExcludeSecondaryZoneId	string	否	当前地域过滤此输入的可用区查询结果，结合“ExcludeZoneId”实现多可用区过滤。	cn-shanghai-b
DBInstanceClass	string	否	实例规格。	dds.mongo.standard
EngineVersion	string	否	数据库版本号。	5.0
ReplicationFactor	string	否	节点数。说明该参数仅支持副本集实例。枚举值： 1 : 1 3 : 3 5 : 5 7 : 7	3
InstanceType	string	否	实例类型，取值： sharding：分片集群实例。 replicate：副本集实例和单节点实例。	replicate

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	19A13A33-0FAD-5120-8AE1-B1636F74DD80
AvailableZones	array<object>	支持购买的可用区资源详情。
	object
ZoneId	string	可用区 ID。	cn-beijing-f
ZoneName	string	可用区名称。根据 AcceptLanguage 参数的值返回不同的语言。以cn-hangzhou-h可用区为例，示例如下： AcceptLanguage 为 zh：杭州可用区 H AcceptLanguage 为 en：Hangzhou Zone H	杭州可用区H
RegionId	string	地域 ID。您可以通过调用 DescribeRegions 接口查询。	cn-beijing

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。