文档

DescribeRegions - 查询可以使用的阿里云地域

查看MongoDB实例支持的所有地域和可用区。

接口说明

说明 如需查询创建实例可用的地域和可用区信息,请调用 DescribeAvailableResource 查询。

调试

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

授权信息

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

请求参数

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

地域 ID。

说明 如果不填写,默认查询所有支持的地域。
cn-hangzhou
AcceptLanguagestring

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

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

返回参数

名称类型描述示例值
object

地域和可用区列表。

RequestIdstring

请求 ID。

4E46C22C-D3B7-4DB8-9C76-63851BE68E20
Regionsobject []

地域列表。

Zonesobject []

可用区列表。

ZoneIdstring

可用区 ID。

cn-hangzhou-h
VpcEnabledboolean

是否支持 VPC,取值说明:

  • true:支持 VPC。
  • false:不支持 VPC。
true
ZoneNamestring

可用区名称。

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

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

地域 ID。

cn-hangzhou
RegionNamestring

地域名称。

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

  • AcceptLanguagezh华东 1(杭州)
  • AcceptLanguageenChina (Hangzhou)
华东1(杭州)
EndPointstring

公网接入地址。

返回对应地域的公网接入地址,以 cn-hangzhou 地域为例,示例如下:

  • mongodb.aliyuncs.com
mongodb.aliyuncs.com

示例

正常返回示例

JSON格式

{
  "RequestId": "4E46C22C-D3B7-4DB8-9C76-63851BE68E20",
  "Regions": {
    "DdsRegion": [
      {
        "Zones": {
          "Zone": [
            {
              "ZoneId": "cn-hangzhou-h",
              "VpcEnabled": true,
              "ZoneName": "杭州 可用区H"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "RegionName": "华东1(杭州)",
        "EndPoint": "mongodb.aliyuncs.com"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-01OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-03-31OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:AcceptLanguage
出参OpenAPI 返回结构发生变更
2022-03-31OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:AcceptLanguage
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈