すべてのプロダクト
Search

このプロダクト

    :ModifyIndex

    ドキュメントセンター

    :ModifyIndex

    最終更新日:Jun 17, 2026

    インデックスを変更します。

    操作説明

    メソッド

    PUT

    URI

    /openapi/ha3/instances/{instanceId}/indexes/{indexName}
```。

    今すぐお試しください

    この 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:ModifyIndex

    update

    *Instance

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

    		 なし なし

    リクエスト構文

    PUT /openapi/ha3/instances/{instanceId}/indexes/{indexName} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    ha-cn-pl32rf0****
    indexName

    string

    必須

    インデックス名。

    test_api

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    dryRun

    boolean

    任意

    実際の操作を実行せずに入力パラメーターの検証のみを行うかどうかを指定します。デフォルト値: false。

    有効な値:

    • true: パラメーターの有効性のみを検証します。

    • false: パラメーターの有効性を検証し、属性構成を作成します。

    true
    body

    object

    任意

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

    dataSourceInfo

    object

    任意

    データソース情報。このパラメーターは新バージョンの AISearch で必須です。

    buildMode

    string

    任意

    インデックス再構築モード。有効な値: api (API を通じてデータソースをプッシュ) および indexRecover (インデックスからデータソースを回復)。

    api
    generation

    integer

    任意

    インデックスからデータソースを回復する際のダンプテーブルの世代。

    1718698593
    dataTimeSec

    integer

    任意

    増分データ追跡のタイムスタンプ。

    1709715164
    processPartitionCount

    integer

    任意

    データ更新のリソース数。

    4
    name

    string

    任意

    データソース名。

    ha-cn-pl32rf0****_index_1
    type

    string

    任意

    データソースタイプ。有効な値: odps、swift、saro、oss、unKnow。

    odps
    domain

    string

    任意

    オフライン Deployment。

    vpc_hz_domain_1

    config

    object

    任意

    ODPS データソース構成。

    endpoint

    string

    任意

    ODPS データソースのエンドポイント。

    http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
    accessKey

    string

    任意

    ODPS データソースの AccessKey ID。

    L***p
    accessSecret

    string

    任意

    ODPS データソースの AccessKey シークレット。

    5**9a6
    project

    string

    任意

    ODPS プロジェクトの名前。

    bbt_algo_pai
    partition

    string

    任意

    ODPS パーティション。例: `ds=20180102`。

    ds=20230114
    table

    string

    任意

    saro または ODPS テーブルの名前。

    item
    namespace

    string

    任意

    saro データソースの名前空間。

    test-namespace
    path

    string

    任意

    HDFS データソースのパス。

    test-hdfs-path
    ossPath

    string

    任意

    OSS データソースのパス。

    /opensearch/oss.json
    bucket

    string

    任意

    OSS バケット。

    test-bucket
    format

    string

    任意

    OSS バケット内のファイルのフォーマット。

    • ha3

    • json

    ha3
    catalog

    string

    任意

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

    test-catalog
    database

    string

    任意

    DLF データソースのデータベース。

    test-database
    tag

    string

    任意

    DLF データソースのタグ。

    test-tag
    tableFormat

    string

    任意

    DLF データソースのテーブルフォーマット。

    paimon lance object
    saroConfig

    object

    任意

    saro データソース構成。

    namespace

    string

    任意

    saro データソースの名前空間。

    flink-test-fjx-default
    tableName

    string

    任意

    saro データテーブルの名前。

    device_event_shy_summary_
    autoBuildIndex

    boolean

    任意

    自動フルインデックス作成を有効にするかどうかを指定します。

    true
    processParallelNum

    integer

    任意

    同時フルインデックス作成プロセスの数。

    2
    partition

    string

    任意

    ODPS データソースパーティション。このパラメーターはデータソースタイプが ODPS の場合に必須です。

    ds=20230114
    ossDataPath

    string

    任意

    OSS データソースからのインデックス再構築用に選択されたファイルパス。

    /opensearch/oss.json
    description

    string

    任意

    説明。

    "test"
    content

    string

    任意

    ファイルの内容。

    {\"summarys\":{\"summary_fields\":[\"id\"]},\"indexs\":[{\"index_name\":\"index_id\",\"index_type\":\"PRIMARYKEY64\",\"index_fields\":\"id\",\"has_primary_key_attribute\":true,\"is_primary_key_sorted\":false}],\"attributes\":[\"id\"],\"fields\":[{\"field_name\":\"id\",\"field_type\":\"UINT16\"}],\"table_name\":\"index_2\"}
    partition

    integer

    任意

    データパーティション。

    2
    dataSource

    string

    任意

    データソース。

    ha-cn-pl32rf0****_index_1
    domain

    string

    任意

    データソースの Deployment。

    vpc_hz_domain_1
    buildParallelNum

    integer

    任意

    同時フルインデックス作成ビルドスレッドの数。

    2
    mergeParallelNum

    integer

    任意

    同時フルインデックス作成マージスレッドの数。

    2
    cluster

    object

    任意

    クラスター情報。

    object

    任意

    Cluster information

    object

    任意

    Content updates for cluster.json

    value

    string

    任意

    Variable

    partition
    description

    string

    任意

    Description

    Custom Variable
    disableModify

    boolean

    任意

    Whether the user can modify this

    true
    isModify

    boolean

    任意

    Whether this has been modified

    false
    type

    string

    任意

    Normal variable: NORMAL, function variable: FUNCTION

    NORMAL
    clusterConfigName

    string

    任意

    クラスターの cluster.json ファイル名。

    ha-cn-pl32rf0****@a-cn-pl32rf0****_test_api@hz_pre_vpc_domain_1@test_api@index_config_v1
    config

    object

    任意

    オフライン構成情報。

    object

    任意

    Offline configuration

    desc

    string

    任意

    Remarks

    test
    files

    array<object>

    任意

    List of modified files

    array<object>

    任意

    operateType

    string

    任意

    操作タイプ。有効な値: UPDATE および DELETE。デフォルト値: UPDATE。

    UPDATE
    parentFullPath

    string

    任意

    親フォルダのパス。

    /
    fileName

    string

    任意

    ファイル名。

    /intervene_dict/analyzer.dict
    config

    object

    任意

    更新のための構成。

    content

    string

    任意

    ファイルの内容。これは辞書構成です。

    $dictContent
    variables

    object

    任意

    変数。

    object

    任意

    変数情報。

    description

    string

    任意

    説明。

    test
    disableModify

    boolean

    任意

    ユーザーが変数を変更できるかどうかを指定します。

    true
    isModify

    boolean

    任意

    変数が変更されたかどうかを指定します。

    false
    type

    string

    任意

    変数のタイプ。有効な値: 通常の変数の場合は NORMAL、関数変数の場合は FUNCTION。

    NORMAL
    value

    string

    任意

    変数の値。

    test
    dirName

    string

    任意

    フォルダ名。

    /test
    pushMode

    string

    任意

    プッシュ構成モード。デフォルト値: 構成のプッシュのみ。

    PUSH_ONLY
    extend

    object

    任意

    フィールド構成の拡張コンテンツ。キー: vector (ベクトルフィールド)、embeding (埋め込みが必要なフィールド)、または description (備考フィールド)。値: ["schema フィールド名"]。

    { "vector": [ "source_image_vector" ], "embeding": [ "source_image" ], "description": [] }

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    requestId

    string

    リクエスト ID。

    93A9E542-8CF8-5BA6-99AB-94C0FE520429
    result

    any

    返された結果。

    {}

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
  "result": "{}"
}

    エラーコード

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

    変更履歴

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