All Products
Search
Document Center

OpenSearch:DescribeRegions

Last Updated:Mar 03, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v4/openapi/regions

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
resultobject []

The result that was returned.

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

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.

Change history

Change timeSummary of changesOperation
No change history