すべてのプロダクト
Search

このプロダクト

    :BuildIndex

    ドキュメントセンター

    :BuildIndex

    最終更新日:Sep 22, 2025

    インデックスを再構築します。

    操作説明

    メソッド

    POST

    URI

    /openapi/ha3/instances/{instanceId}/actions/build-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:BuildIndex

    update

    *Instance

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

    		 なし なし

    リクエスト構文

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンスの ID。

    ha-cn-pl32rf0****
    body

    object

    任意

    JSON 文字列です。詳細については、以下の説明をご参照ください。

    {}
    dataSourceName

    string

    任意

    データソースの名前。

    ha-cn-pl32rf0****_test_api
    domain

    string

    任意

    データソースのデータセンター。

    sz_vpc_domain_1
    dataSourceType

    string

    任意

    データソースのタイプ。

    odps
    partition

    string

    任意

    dataSourceType が odps に設定されている場合に必須です。

    ds=20201010
    dataTimeSec

    integer

    任意

    秒単位の UNIX タイムスタンプ。このパラメーターは整数です。API を使用してデータソースにデータがプッシュされる場合、このパラメーターは必須です。

    1640867288
    buildMode

    string

    任意

    インデックスを再構築するメソッド。有効な値: api および indexRecover。

    api
    generation

    integer

    任意

    バックフィル ID。

    160131146
    tag

    string

    任意

    Data Lake Formation (DLF) データソースのタグ。

    test
    path

    string

    任意

    相対パス。

    /test/dir

    リクエストの例

    POST /openapi/ha3/instances/ha3_instance_name/actions/build-index


     {
    "dataSourceName": "my_data_source",
    "domain": "test", // データソースのデプロイメント。
    "indexes": [
      "index1",
      "index2"
    ],
    "dataSourceType": "odps", // 必須。有効な値: odps および swift。
    "partition": "20201010", // dataSourceType が odps に設定されている場合に必須です。
    "dataTimeSec": 1640867288 // 秒単位の UNIX タイムスタンプ。このパラメーターは整数です。API を使用してデータソースにデータがプッシュされる場合に必須です。
  }


    {
    "dataSourceName": "my_data_source",
    "domain": "test", // データソースのデプロイメント。
    "indexes": [
      "index1",
      "index2"
    ],
    "dataSourceType": "swift", // 必須。有効な値: odps および swift。
    "partition": "20201010", // dataSourceType が odps に設定されている場合に必須です。
    "dataTimeSec": 1640867288 // 秒単位の UNIX タイムスタンプ。このパラメーターは整数です。API を使用してデータソースにデータがプッシュされる場合に必須です。
  }

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    requestId

    string

    リクエストの ID。

    407BFD91-DE7D-50BA-8F88-CDE52A3B5E46
    result

    object

    返された結果。

    {}

    レスポンスの例

    成功レスポンスの例 

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

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

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "407BFD91-DE7D-50BA-8F88-CDE52A3B5E46",
  "result": {}
}

    エラーコード

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

    変更履歴

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