すべてのプロダクト
Search

このプロダクト

    :CreateIndex

    ドキュメントセンター

    :CreateIndex

    最終更新日:Sep 29, 2025

    インデックスを作成します。

    操作説明

    メソッド

    POST

    URI

    /openapi/ha3/instances/{instanceId}/indexes

    今すぐお試しください

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

    create

    *Instance

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

    		 なし なし

    リクエスト構文

    POST /openapi/ha3/instances/{instanceId}/indexes HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    ha-cn-2r42ppr****
    body

    object

    任意

    リクエストボディ。

    {}
    name

    string

    任意

    インデックスの名前。

    index_1
    dataSource

    string

    任意

    データソースの名前。

    ha-cn-35t3n1y****_index_1
    domain

    string

    任意

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

    vpc_hz_domain_1
    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
    dataSourceInfo

    object

    任意

    データソースに関する情報。このパラメーターは、Vector Search Edition の新しいバージョンで必要です。

    dataTimeSec

    integer

    任意

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

    1709715164
    processPartitionCount

    integer

    任意

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

    4
    name

    string

    任意

    データソースの名前。

    ha-cn-35t3n1y****_index_1
    type

    string

    任意

    データソースのタイプ。有効な値:

    • odps

    • swift

    • saro

    • oss

    odps
    domain

    string

    任意

    オフラインデータセンター。

    vpc_hz_domain_1

    config

    object

    任意

    ODPS 関連の構成。

    endpoint

    string

    任意

    ODPS または OSS データソースのエンドポイント。

    https://oss-cn-hangzhou.aliyuncs.com
    accessKey

    string

    任意

    ODPS データソースの AccessKey ID。

    L***p
    accessSecret

    string

    任意

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

    5**9a6
    project

    string

    任意

    ODPS プロジェクトの名前。

    bbt_algo_pai
    partition

    string

    任意

    データソースタイプが ODPS の場合、このパラメーターは必須です。

    ds=20230114
    table

    string

    任意

    テーブルの名前。

    bbt_rec_swing_u2i2i_score_be_v1
    namespace

    string

    任意

    名前空間。

    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

    任意

    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 データソースの名前空間。この機能は内部でのみ使用できます。

    test
    tableName

    string

    任意

    Saro データテーブルの名前。この機能は内部でのみ使用できます。

    tableA
    autoBuildIndex

    boolean

    任意

    完全なインデックス作成を自動的にトリガーするかどうかを指定します。

    true
    processParallelNum

    integer

    任意

    完全なデータ処理の同時実行数。

    2
    scene

    string

    任意

    テンプレートのタイプ。

    videoSearcher
    extend

    object

    任意

    拡張フィールド構成。

    • key: フィールドタイプ。有効な値: `vector` (ベクターフィールド)、`embeding` (埋め込みが必要なフィールド)、および `description` (説明フィールド)。

    • value: スキーマ内のフィールドの名前 (例: `["field_name"]`)。

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

    integer

    任意

    完全なインデックス構築の同時実行数。

    2
    mergeParallelNum

    integer

    任意

    完全なインデックスマージの同時実行数。

    2
    dryRun

    boolean

    任意

    ドライランを実行するかどうかを指定します。ドライランは、データソースが有効かどうかのみをチェックします。有効な値:

    • true

    • false

    true

    リクエスト例

    POST /openapi/ha3/instances/ose-test1/indexes

    {
    "name": "index_1",
    "dataSource": "ha-cn-3********0d_index_1",
    "content": "",
    "extend":
    {
        "vector":
        [
            "source_image_vector"
        ],
        "embeding":
        [
            "source_image"
        ],
        "description":
        []
    },
    "partition": 1,
    "dataSourceInfo":
    {
        "type": "odps",
        "processPartitionCount": 2,
        "autoBuildIndex": true,
        "config":
        {
            "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun.com/api",
            "project": "odps_project",
            "accessKey": "ak",
            "accessSecret": "as",
            "table": "odps_table",
            "partition": "ds=*******"
        },
        "saroConfig":
        {},
        "dataTimeSec": 1709715164
    }
}

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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": {}
}

    エラーコード

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

    変更履歴

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