All Products
Search
Document Center

OpenSearch:CreateAlias

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

POST /openapi/ha3/instances/{instanceId}/aliases

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-pl32rf0****
newModebooleanNo

Specifies whether the OpenSearch Vector Search Edition instance is of the new version.

true
bodyobjectNo

The request body.

aliasstringNo

alias name

test
indexstringNo

index name

index

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

id of request

10D5E615-69F7-5F49-B850-00169ADE513C
resultobject

Map

{}

Examples

Sample success responses

JSONformat

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": {}
}

Error codes

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