You can call the DescribeRegions to obtain the region information of the Alibaba Cloud Elasticsearch.

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 headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

GET /openapi/regions HTTP/1.1

Request parameters

N/A

None

Response parameters

Parameter Type Example Description
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1ADFG

The ID of the request.

Result Array of regionInfo

The list of returned database shards.

regionId String cn-hangzhou

The region ID of the cluster.

status String available

The available status of the region.

regionEndpoint String elasticsearch.cn-hangzhou.aliyuncs.com

The endpoint of the region.

localName String China (Hangzhou)

The name of the region.

consoleEndpoint String https://elasticsearch-cn-hangzhou.console.aliyun.com

The endpoint of the region that is exposed in the console.

Examples

Sample requests

GET /openapi/regions HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Sample responses

JSON format 

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

{
  "Result" : [ {
    "regionId" : "cn-hangzhou",
    "localName" : "China (Hangzhou)",
    "regionEndpoint" : "elasticsearch.cn-hangzhou.aliyuncs.com",
    "consoleEndpoint" : "https://elasticsearch-cn-hangzhou.console.aliyun.com",
    "status" : "available"
  } ],
  "RequestId" : "D080B90F-C600-53C3-BB4B-7A094118EB21"
}

Error codes

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