Queries the endpoints of all regions that support OpenSearch.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/regions HTTP/1.1

Request parameters

Response parameters

Parameter Type Example Description
requestId String 3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB

The ID of the request.

result Array of result

The result that was returned.

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

The URL of the OpenSearch console.

endpoint String opensearch.cn-hangzhou.aliyuncs.com

The endpoint of the region.

localName String China (Hangzhou)

The name of the region.

regionId String cn-hangzhou

The ID of the region.

Examples

Sample requests

GET /v4/openapi/regions

Sample success responses

XML format

<requestId>3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB</requestId>
<result>
    <regionId>cn-hangzhou</regionId>
    <localName>China (Hangzhou)</localName>
    <endpoint>opensearch.cn-hangzhou.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-cn-hangzhou.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>cn-shanghai</regionId>
    <localName>China (Shanghai)</localName>
    <endpoint>opensearch.cn-shanghai.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-cn-shanghai.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>cn-qingdao</regionId>
    <localName>China (Qingdao)</localName>
    <endpoint>opensearch.cn-qingdao.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-cn-qingdao.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>cn-beijing</regionId>
    <localName>China (Beijing)</localName>
    <endpoint>opensearch.cn-beijing.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-cn-beijing.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>cn-zhangjiakou</regionId>
    <localName>China (Zhangjiakou)</localName>
    <endpoint>opensearch.cn-zhangjiakou.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-cn-zhangjiakou.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>cn-shenzhen</regionId>
    <localName>China (Shenzhen)</localName>
    <endpoint>opensearch.cn-shenzhen.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-cn-shenzhen.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>ap-southeast-1</regionId>
    <localName>Singapore (Singapore)</localName>
    <endpoint>opensearch.ap-southeast-1.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-ap-southeast-1.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>cn-internal</regionId>
    <localName>Internal Center</localName>
    <endpoint>opensearch.cn-zhangbei-center.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-cn-shanghai-in.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>cn-zhangbei-in</regionId>
    <localName>Internal Center (Zhangjiakou)</localName>
    <endpoint>opensearch.cn-zhangbei-in.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-cn-zhangbei-in.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>us-west-1-in</regionId>
    <localName>Internal Center (US)</localName>
    <endpoint>opensearch.innet-us.aliyuncs.com</endpoint>
    <consoleUrl>http://opensearch-us-in.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>rus-west-1-in</regionId>
    <localName>Internal Center (Russia)</localName>
    <endpoint/>
    <consoleUrl>https://opensearch-rg-ru-in.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>cn-daily</regionId>
    <localName>Internal Center (Daily Environment)</localName>
    <endpoint>opensearch.cn-daily.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-cn-daily.console.aliyun.com</consoleUrl>
</result>
<result>
    <regionId>pre-hangzhou</regionId>
    <localName>China (Hangzhou)-Staging</localName>
    <endpoint>opensearch.pre-hangzhou.aliyuncs.com</endpoint>
    <consoleUrl>https://opensearch-pre-hangzhou.console.aliyun.com</consoleUrl>
</result>

JSON format

{
    "requestId": "3B7E42BD-1D63-2F6B-C8E0-41BACEA76EEB",
    "result": [
        {
            "regionId": "cn-hangzhou",
            "localName": "China (Hangzhou)",
            "endpoint": "opensearch.cn-hangzhou.aliyuncs.com",
            "consoleUrl": "https://opensearch-cn-hangzhou.console.aliyun.com"
        },
        {
            "regionId": "cn-shanghai",
            "localName": "China (Shanghai)",
            "endpoint": "opensearch.cn-shanghai.aliyuncs.com",
            "consoleUrl": "https://opensearch-cn-shanghai.console.aliyun.com"
        },
        {
            "regionId": "cn-qingdao",
            "localName": "China (Qingdao)",
            "endpoint": "opensearch.cn-qingdao.aliyuncs.com",
            "consoleUrl": "https://opensearch-cn-qingdao.console.aliyun.com"
        },
        {
            "regionId": "cn-beijing",
            "localName": "China (Beijing)",
            "endpoint": "opensearch.cn-beijing.aliyuncs.com",
            "consoleUrl": "https://opensearch-cn-beijing.console.aliyun.com"
        },
        {
            "regionId": "cn-zhangjiakou",
            "localName": "China (Zhangjiakou)",
            "endpoint": "opensearch.cn-zhangjiakou.aliyuncs.com",
            "consoleUrl": "https://opensearch-cn-zhangjiakou.console.aliyun.com"
        },
        {
            "regionId": "cn-shenzhen",
            "localName": "China (Shenzhen)",
            "endpoint": "opensearch.cn-shenzhen.aliyuncs.com",
            "consoleUrl": "https://opensearch-cn-shenzhen.console.aliyun.com"
        },
        {
            "regionId": "ap-southeast-1",
            "localName": "Singapore (Singapore)",
            "endpoint": "opensearch.ap-southeast-1.aliyuncs.com",
            "consoleUrl": "https://opensearch-ap-southeast-1.console.aliyun.com"
        },
        {
            "regionId": "cn-internal",
            "localName": "Internal Center",
            "endpoint": "opensearch.cn-zhangbei-center.aliyuncs.com",
            "consoleUrl": "https://opensearch-cn-shanghai-in.console.aliyun.com"
        },
        {
            "regionId": "cn-zhangbei-in",
            "localName": "Internal Center (Zhangjiakou)",
            "endpoint": "opensearch.cn-zhangbei-in.aliyuncs.com",
            "consoleUrl": "https://opensearch-cn-zhangbei-in.console.aliyun.com"
        },
        {
            "regionId": "us-west-1-in",
            "localName": "Internal Center (US)",
            "endpoint": "opensearch.innet-us.aliyuncs.com",
            "consoleUrl": "http://opensearch-us-in.console.aliyun.com"
        },
        {
            "regionId": "rus-west-1-in",
            "localName": "Internal Center (Russia)",
            "endpoint": "",
            "consoleUrl": "https://opensearch-rg-ru-in.console.aliyun.com"
        },
        {
            "regionId": "cn-daily",
            "localName": "Internal Center (Daily Environment)",
            "endpoint": "opensearch.cn-daily.aliyuncs.com",
            "consoleUrl": "https://opensearch-cn-daily.console.aliyun.com"
        },
        {
            "regionId": "pre-hangzhou",
            "localName": "China (Hangzhou)-Staging",
            "endpoint": "opensearch.pre-hangzhou.aliyuncs.com",
            "consoleUrl": "https://opensearch-pre-hangzhou.console.aliyun.com"
        }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.