DescribeRegions - OpenSearch - Alibaba Cloud Documentation Center

Authorization information

There is currently no authorization information disclosed in the API.

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 ID of the request.	3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB
result	array	The result that was returned.
	object
endpoint	string	The endpoint of the region.	opensearch.cn-hangzhou.aliyuncs.com
regionId	string	The ID of the region.	cn-hangzhou
localName	string	The name of the region.
consoleUrl	string	The URL of the OpenSearch console.	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": "",
      "consoleUrl": "https://opensearch-cn-hangzhou.console.aliyun.com"
    }
  ]
}

Error codes

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