All Products
Search
Document Center

OpenSearch:DescribeRegions

Last Updated:Feb 01, 2023

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The ID of the request.

3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB
resultarray

The result that was returned.

object
endpointstring

The endpoint of the region.

opensearch.cn-hangzhou.aliyuncs.com
regionIdstring

The ID of the region.

cn-hangzhou
localNamestring

The name of the region.

consoleUrlstring

The URL of the OpenSearch console.

https://opensearch-cn-hangzhou.console.aliyun.com

Example

Normal return example

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 API error center.