Queries details about regions and zones of ApsaraDB for MongoDB instances.

Note To query available regions and zones where ApsaraDB for MongoDB instances 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRegions

The operation that you want to perform. Set the value to DescribeRegions.

RegionId String No cn-hangzhou

The ID of the region.

Note If you do not specify this parameter, all supported regions are queried.
AcceptLanguage String No en

Specifies the language of the returned RegionName and ZoneName values. Default value: zh. Valid values:

  • zh: Chinese.
  • en: English

Response parameters

Parameter Type Example Description
RequestId String 4E46C22C-D3B7-4DB8-9C76-63851BE68E20

The ID of the request.

Regions Array of DdsRegion

Details about the regions.

DdsRegion
Zones Array of Zone

Details about the zones.

Zone
ZoneId String cn-hangzhou-h

The ID of the zone.

VpcEnabled Boolean true

Indicates whether a virtual private cloud (VPC) is supported. Valid values:

  • true: VPC is supported.
  • false: VPC is not supported.
ZoneName String Hangzhou Zone H

The name of the zone.

The return value of the LocalName parameter is in the language that is specified by the AcceptLanguage parameter.

RegionId String cn-hangzhou

The ID of the region.

RegionName String China (Hangzhou)

The name of the region.

The return value of the LocalName parameter is in the language that is specified by the AcceptLanguage parameter.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=DescribeRegions
&RegionId=cn-hangzhou
&AcceptLanguage=en
&<Common request parameters>

Sample responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeRegionsResponse>
    <RequestId>4E46C22C-D3B7-4DB8-9C76-63851BE68E20</RequestId>
    <Regions>
        <Zones>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <VpcEnabled>true</VpcEnabled>
            <ZoneName>Hangzhou Zone H</ZoneName>
        </Zones>
        <RegionId>cn-hangzhou</RegionId>
        <RegionName>China (Hangzhou)</RegionName>
    </Regions>
</DescribeRegionsResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.