All Products
Search
Document Center

OpenSearch:ListAliases

Last Updated:Jul 16, 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 /openapi/ha3/instances/{instanceId}/aliases

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-pl32rf0****

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

id of request

10D5E615-69F7-5F49-B850-00169ADE513C
resultarray<object>

List

object

The results returned.

aliasstring

alias name

test
indexstring

index name

index

Examples

Sample success responses

JSONformat

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": [
    {
      "alias": "test",
      "index": "index"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.