DescribeRegions API Reference for OpenSearch Endpoints - OpenSearch

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /v4/openapi/regions HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB
result	array<object>	The 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.console.alibabacloud.com

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.