All Products
Search
Document Center

OpenSearch:ModifyIndexVersion

Last Updated:Jul 16, 2024

Modifies the index version of a cluster (an index version rollback).

Operation description

Method

PUT

URI

/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version

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

PUT /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/index-version

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-7mz2j2off06
clusterNamestringNo

The name of the cluster.

vpc_hz_domain_2
bodyarray<object>No

The request body.

{}
objectNo

The keyword used to search for a version. Fuzzy match is supported.

indexNamestringNo

The index name.

main_index
versionstringNo

The index version.

1
buildDeployIdstringNo

The deployment ID of the data source.

277

Sample requests



PUT /openapi/ha3/instances/ha3_instance_nameclusters/test_cluster/index-version



[

  {

    "indexName": "index1",

    "version": "123456",

    "buildDeployId": "20201010"

  },

  {

    "indexName": "index1",

    "version": "123456",

    "buildDeployId": "20201010"

  }

]

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

id of request

F43E8AB4-419C-5F4C-90D6-615590DFAA3C
resultobject

result

{}

Sample responses

Sample success responses

{
 
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
 
  "result":[]
 
}

For more information, see Response structure.

Examples

Sample success responses

JSONformat

{
  "requestId": "F43E8AB4-419C-5F4C-90D6-615590DFAA3C",
  "result": {}
}

Error codes

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

Change history

Change timeSummary of changesOperation
2022-01-12Add OperationView Change Details