GetIndexVersion - OpenSearch - Alibaba Cloud Documentation Center

Queries the information about index versions that the current index version can be rolled back to.

Operation description

Method

GET

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-2r42ostoc01
clusterName	string	Yes	The name of the cluster	vpc_hz_domain_1

Examples

Sample requests

GET  /openapi/ha3/instances/ha3_instance_id_1/clusters/cluster1/index-version

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	id of request	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	The clusters.
cluster	string	The cluster name.	ayoss-cn-zhangjiakou-b
indexVersions	array<object>	The index versions.
	object	The list of index versions
indexName	string	The name of the index table.	table4
versions	array	The index versions.
	long	The index version.	1
buildDeployId	string	The ID of the offline deployment.	" "
currentVersion	long	The current online version number.	1

Sample responses

Success responses

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "cluster": "ea119cloud",
    "indexVersions": [
      {
        "versions": [
          1630527077,
          1630440554
        ],
        "currentVersion":1630527077,
        "indexName": "ihome_lapp_content_filter_param_index",
        "buildDeployId": "2837"
      },
      {
        "versions": [
          1630353700
        ],
        "currentVersion":1630353700,        
        "indexName": "ihome_lapp_case_tab_filter",
        "buildDeployId": "2829"
      }
    ]
  }
}

Examples

Sample success responses

JSONformat

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {
    "cluster": "ayoss-cn-zhangjiakou-b",
    "indexVersions": [
      {
        "indexName": "table4",
        "versions": [
          1
        ],
        "buildDeployId": "\" \"",
        "currentVersion": 1
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-01-12	Add Operation	View Change Details