DescribeRegions - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries all regions and zones supported for an ApsaraDB for MongoDB instance.

Operation description

Note To query available regions and zones in which an ApsaraDB for MongoDB instance can be created, call the DescribeAvailableResource operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Note If you do not specify this parameter, all supported regions are queried.	cn-hangzhou
AcceptLanguage	string	No	The language of the values of the returned RegionName and ZoneName parameters. Valid values: zh (default) en	zh

Response parameters

Parameter	Type	Description	Example
	object	The regions and zones.
RequestId	string	The request ID.	4E46C22C-D3B7-4DB8-9C76-63851BE68E20
Regions	array<object>	The regions.
	object	The region.
Zones	array<object>	The zones.
	object	The zone.
ZoneId	string	The zone ID.	cn-hangzhou-h
VpcEnabled	boolean	Indicates whether a virtual private cloud (VPC) is supported. Valid values: true: VPC is supported. false: VPC is not supported.	true
ZoneName	string	The name of the zone. The value of the ZoneName parameter is in the language that is specified by the AcceptLanguage parameter. For example, if the value of the ZoneId parameter in the response is cn-hangzhou-h, the following values are returned for the ZoneName parameter: If the value of the AcceptLanguage parameter is zh, the value H is returned for the ZoneName parameter. If the value of the AcceptLanguage parameter is en, the value Hangzhou Zone H is returned for the ZoneName parameter.	Hangzhou Zone H
RegionId	string	The region ID.	cn-hangzhou
EndPoint	string	The public endpoint of the region. For example, if the value of the RegionId parameter in the response is cn-hangzhou, the following value is returned for the EndPoint parameter: mongodb.aliyuncs.com	mongodb.aliyuncs.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "4E46C22C-D3B7-4DB8-9C76-63851BE68E20",
  "Regions": {
    "DdsRegion": [
      {
        "Zones": {
          "Zone": [
            {
              "ZoneId": "cn-hangzhou-h",
              "VpcEnabled": true,
              "ZoneName": "Hangzhou Zone H"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "RegionName": "China (Hangzhou)",
        "EndPoint": "mongodb.aliyuncs.com"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-01	The response structure of the API has changed	View Change Details
2022-03-31	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2022-03-31	The request parameters of the API has changed. The response structure of the API has changed	View Change Details