All Products
Search
Document Center

API Gateway:DescribeRegions

Last Updated:Mar 01, 2024

Queries the Alibaba Cloud regions that are supported by API Gateway.

Operation description

This operation queries regions in which API Gateway is available.

  • This operation is intended for API providers and callers.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LanguagestringNo

The language in which you want to return the descriptions of the access control policies. Valid values:

  • zh-CN (default value): Chinese
  • en: English
  • ja: Japanese
zh

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

36BBBAD4-1CFB-489F-841A-8CA52EEA787E
Regionsobject []

The returned region information. It is an array that consists of Region data.

cn-huhehaote
RegionEndpointstring

The endpoint of the service for the region.

apigateway.cn-shenzhen.aliyuncs.com
LocalNamestring

The name of the region.

China (Shenzhen)
RegionIdstring

The ID of the region.

cn-shenzhen

Examples

Sample success responses

JSONformat

{
  "RequestId": "36BBBAD4-1CFB-489F-841A-8CA52EEA787E",
  "Regions": {
    "Region": [
      {
        "RegionEndpoint": "apigateway.cn-shenzhen.aliyuncs.com",
        "LocalName": "China (Shenzhen)\n",
        "RegionId": "cn-shenzhen"
      }
    ]
  }
}

Error codes

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