All Products
Search
Document Center

OpenSearch:RecoverIndex

Last Updated:Jul 16, 2024

Restores data from an index.

Operation description

Method

POST

URI

/openapi/ha3/instances/{instanceId}/recover-index

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}/recover-index

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-zvp2jlr2g03
bodyobjectNo

The request body.

dataSourceNamestringNo

The name of the data source.

ha-cn-pl32rf0js04_odps_first
indexNamestringNo

The index name.

main_index
generationstringNo

The ID of the full index version.

1653018575
buildDeployIdintegerNo

The deployment ID of the data source.

277

Sample requests

POST /openapi/ha3/instances/ha3_instances_id/recover-index

{
  "generation": "1653018575",
  "dataSourceName":"test_yyds_data1",
  "buildDeployId":277,
  "indexName":"index_1"
}

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The ID of the request.

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

The result returned by data search.

{}

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.

Change history

Change timeSummary of changesOperation
2024-05-06The internal configuration of the API is changed, but the call is not affectedView Change Details