DescribeRegions - OpenSearch - Alibaba Cloud Documentation Center

Queries the endpoints of all regions that support OpenSearch.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v4/openapi/regions HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The request ID.	3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB
result	array<object>	The results returned.
result	object
endpoint	string	The endpoint.	opensearch.cn-hangzhou.aliyuncs.com
regionId	string	The region ID.	cn-hangzhou
localName	string	The region name.	China (Hangzhou)
consoleUrl	string	The console URL.	https://opensearch-cn-hangzhou.console.aliyun.com

Examples

Sample success responses

JSONformat

{
  "requestId": "3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB",
  "result": [
    {
      "endpoint": "opensearch.cn-hangzhou.aliyuncs.com",
      "regionId": "cn-hangzhou",
      "localName": "China (Hangzhou)\n",
      "consoleUrl": "https://opensearch-cn-hangzhou.console.aliyun.com"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history