すべてのプロダクト
Search

このプロダクト

    :RecoverIndex

    ドキュメントセンター

    :RecoverIndex

    最終更新日:Sep 24, 2026

    インデックスからデータを回復します。

    操作説明

    メソッド

    POST

    URI

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

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    searchengine:RecoverIndex

    update

    *インスタンス。

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

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンスの ID。

    ha-cn-pl32rf0****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    body

    object

    任意

    リクエストボディのパラメーター。

    dataSourceName

    string

    任意

    データソースの名前。

    ha-cn-pl32rf0****_test_api
    indexName

    string

    任意

    インデックスの名前。

    test_api
    generation

    string

    任意

    インデックスの完全なバージョン。

    1653018575
    buildDeployId

    integer

    任意

    データソースのオフライン Deployment の ID。この値は、 GetIndexVersion 操作を呼び出すことで取得できます。

    277
    outPutType

    string

    任意

    エクスポートタイプ。デフォルト値: インデックス再構築用の内部 HDFS にエクスポート。有効な値: oss、odps。

    oss
    bucket

    string

    任意

    OSS バケットの名前。このパラメーターは、データを OSS にエクスポートする場合に必須です。

    path

    string

    任意

    OSS パス。このパラメーターは、データを OSS にエクスポートする場合に必須です。パスはスラッシュ (/) で始まる必要があります。

    odpsAccessId

    string

    任意

    MaxCompute AccessKey ID。このパラメーターは、データを MaxCompute にエクスポートする場合に必須です。

    odpsAccessKey

    string

    任意

    MaxCompute AccessKey Secret。このパラメーターは、データを MaxCompute にエクスポートする場合に必須です。

    odpsProject

    string

    任意

    MaxCompute プロジェクトの名前。このパラメーターは、データを MaxCompute にエクスポートする場合に必須です。

    odpsTable

    string

    任意

    MaxCompute テーブルの名前。このパラメーターは、データを MaxCompute にエクスポートする場合に必須です。

    odpsPartition

    string

    任意

    MaxCompute パーティション。このパラメーターは、データを MaxCompute にエクスポートする場合に必須です。

    リクエスト例 - 内部 HDFS へのデフォルトエクスポート

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

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

    リクエスト例 - OSS へのエクスポート

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

    {
  "generation": "1653018575",
  "dataSourceName":"test_yyds_data1",
  "buildDeployId":277,
  "indexName":"index_1",
  "outPutType":"oss",
  "bucket":"my-bucket",
  "path":"/opensearch/recover_data"
}

    リクエスト例 - MaxCompute へのエクスポート

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

    {
  "generation": "1653018575",
  "dataSourceName":"test_yyds_data1",
  "buildDeployId":277,
  "indexName":"index_1",
  "outPutType":"odps",
  "odpsAccessId":"LTAI5txxxxxxxx",
  "odpsAccessKey":"xxxxxxxxxxxxxxxxxx",
  "odpsProject":"my_project",
  "odpsTable":"recover_table",
  "odpsPartition":"pt=20240101"
}

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    requestId

    string

    リクエストの ID。

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

    object

    返される結果。

    {}

    レスポンス例

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

    詳細については、「レスポンス構造」を参照してください。

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。