DescribeRegions API Reference for OpenSearch Regions - OpenSearch

Operation description

Method

GET

URI

/openapi/ha3/regions

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 /openapi/ha3/regions HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
acceptLanguage	string	No	The language of the response. Default value: zh-cn.	zh-cn

Response elements

Element	Type	Description	Example
	object
requestId	string	id of request	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	array<object>	The result.
	object	The result.
localName	string	The name of the region.	China (Hangzhou)
endpoint	string	The endpoint of the region.	endpoint
regionId	string	The ID of the region. Valid values: cn-hangzhou: China (Hangzhou) cn-shanghai: China (Shanghai) cn-qingdao: China (Qingdao) cn-beijing: China (Beijing) cn-zhangjiakou: China (Zhangjiakou) cn-shenzhen: China (Shenzhen) ap-southeast-1: Singapore (Singapore) cn-internal: Internal Center cn-zhangbei-in: Internal Center (Zhangjiakou) us-west-1-in: Internal Center (US) rus-west-1-in: Internal Center (Russia) cn-daily: Daily Environment cn-test: Joint Debugging pre-hangzhou: China (Hangzhou)-Staging	cn-hangzhou

Examples

Success response

JSON format

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": [
    {
      "localName": "China (Hangzhou)",
      "endpoint": "endpoint",
      "regionId": "cn-hangzhou"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.