All Products
Search

This Product

    OpenSearch:RecoverIndex

    Document Center

    OpenSearch:RecoverIndex

    Last Updated:Aug 11, 2026

    Recovers data from an index.

    Operation description

    Method

    POST

    URI

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

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    searchengine:RecoverIndex

    update

    *Instance

    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 None None

    Request syntax

    POST /openapi/ha3/instances/{instanceId}/recover-index HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    instanceId

    string

    Yes

    The instance ID.

    ha-cn-pl32rf0****

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    body

    object

    No

    The request body.

    dataSourceName

    string

    No

    The data source name.

    ha-cn-pl32rf0****_test_api
    indexName

    string

    No

    The index name.

    test_api
    generation

    string

    No

    The full index version.

    1653018575
    buildDeployId

    integer

    No

    The offline deployment ID of the data source.

    277
    outPutType

    string

    No

    The export type. Valid values:

    • api: exports data to HDFS. This is the default value.

    • oss: exports data to OSS.

    • odps: exports data to MaxCompute.

    bucket

    string

    No

    Required when exporting to OSS.

    path

    string

    No

    Required when exporting to OSS. The path must start with a forward slash (/) and must contain "opensearch" or the bucket must have the opensearch tag.

    odpsAccessId

    string

    No

    Required when exporting to MaxCompute.

    odpsAccessKey

    string

    No

    Required when exporting to MaxCompute.

    odpsProject

    string

    No

    Required when exporting to MaxCompute.

    odpsTable

    string

    No

    Required when exporting to MaxCompute.

    odpsPartition

    string

    No

    Optional when exporting to MaxCompute. Example: pt=20240101.

    Request example

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

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

    Response elements

    Element

    Type

    Description

    Example

    object

    requestId

    string

    The request ID.

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

    object

    The returned result.

    {}

    Response example

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

    For more information, refer to Response structure.

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.