すべてのプロダクト
Search

このプロダクト

    Elasticsearch:API の概要

    ドキュメントセンター

    Elasticsearch:API の概要

    最終更新日:Sep 22, 2026

    このページでは、Elasticsearch Agent Engine エディションで一般的に使用される API を一覧表示します。リクエストパラメーター、レスポンスフィールド、および制限については、このページからリンクされている各オペレーションのページに記載されています。API とその例は Agent Engine エディション 9.99.0 に基づいています。なお、このページは Elasticsearch API の完全なリストではありません。

    操作別の API

    Agent Engine エディションの機能紹介および完全なスタートガイドについては、「機能概要」をご参照ください。

    操作

    リファレンス

    コレクションの作成、更新、削除。スライス、バッキング、エイリアスの管理

    コレクションとスライスの管理

    ドキュメントの読み取りと書き込み、データのバッチ処理、クエリの実行

    ドキュメントの書き込み、読み取り、クエリ操作

    ベクトルフィールドの設定と kNN クエリの実行

    ベクトルフィールドと kNN

    スライスキャッシュのウォームアップとウォームアップタスクのクエリ

    スライスキャッシュのウォームアップ

    スライスデータのコピーと Copy Slice タスクの管理

    Copy Slice

    書き込み可能な Branch Slice の作成と使用

    Branch Slice (ベータ版)

    ベクトルクラスターの設定と候補スライスの自動選択

    ベクトルクラスターリコールモード

    コレクション、バッキング、スライスの実行ステータスの表示

    CAT 監視

    この表以外に、さらに 2 つのエントリーポイントがあります。インスタンスの監視と権限設定については、「インスタンス操作」をご参照ください。数量制限と機能上の制約については、「Agent Engine エディションの制限」をご参照ください。

    リクエストターゲットの選択

    通常のインデックスには、インデックス名でアクセスします。コレクションを使用する場合、コレクション名またはコレクションのエイリアスを介してデータにアクセスし、API がそれを要求する箇所ではリクエスト URL に _slice を指定します。インスタンスのエンドポイント、ネットワーク、および認証については、「Agent Engine エディションインスタンスの作成と接続」をご参照ください。

    Agent Engine エディションのレスポンスは、システムが管理する名前や識別子も公開します。これらを、アプリケーションで指定するビジネス名と区別してください：

    レスポンス情報

    意味と使用法

    書き込み、読み取り、またはクエリのレスポンス内の _index フィールド、および登録レスポンスの backing_index フィールド

    .sc-* という形式の基になるインデックス名である場合があります。トラブルシューティングにのみ使用してください。アプリケーションは、引き続きコレクション名またはエイリアスを介してデータにアクセスする必要があります。

    レスポンス内の _routing の値

    システムが割り当てた内部スライス識別子 (slice_uid) である場合がありますが、これはビジネス上のスライス名とは異なります。これをパースしたり、後続のリクエストで _slice や routing の値として使用したりしないでください。アプリケーションが最初に指定したスライス名を引き続き使用してください。

    スライス管理レスポンスの slice および slice_id フィールド

    tenant-a などのビジネス上のスライス名です。内部の slice_uid とは異なります。

    Branch レスポンスの target_uid フィールド

    宛先スライスの内部 ID であり、繰り返し実行された作成リクエストの結果を検証するために使用されます。宛先にアクセスするには、引き続き target_slice 名を使用してください。

    スライスを削除した後に同じ名前のスライスを登録した場合、新しく登録されたスライスの内部 ID は、削除されたスライスの内部 ID とは異なる場合があります。アプリケーションは、内部識別子からビジネス名を派生させたり、新しいスライスを削除されたスライスのライフサイクルの継続として扱ったりしてはなりません。

    リクエストと結果の評価

    • リクエストの Content-Type JSON リクエストには Content-Type: application/json を使用します。Bulk および Multi Search リクエストには Content-Type: application/x-ndjson を使用し、リクエストボディの末尾に改行を入れてください。

    • アイテムレベルのエラー Bulk、Multi Search、単一スライス登録、およびバッチスライス登録の API は、HTTP 200 レスポンスでアイテムレベルのエラーを報告する場合があります。HTTP ステータスコードのみに依存しないでください。2xx 以外のレスポンスを処理し、成功したレスポンスではトップレベルの errors および items[].result フィールドを確認してください。

    • HTTP 429 サーバーは現在リクエストを拒否しています。上限付きエクスポネンシャルバックオフを使用し、べき等であるか、または結果をすでに確認済みの操作のみを再試行してください。

    • 接続タイムアウトと HTTP 5xx 接続タイムアウトや HTTP 5xx レスポンスは、書き込みが失敗したとは限りません。再試行する前に、固定のドキュメント ID または別のべき等性のメカニズムを使用して結果を検証してください。また、コレクションとスライスの API クイックリファレンス表にある読み取りエンドポイントのいずれかを使用してドキュメントを読み取って確認することもできます。

    • URL の長さ URL 内で多数の _slice 値を渡す場合、リクエストは HTTP リクエスト行の長さ制限 (デフォルトは 4096 バイト、http.max_initial_line_length によって制御) の影響も受けます。スライス名が長い場合、スライスの数量制限に達する前に too_long_http_line_exception が発生することがあります。

    • 管理タイムアウト コレクション管理 API は、一般的に master_timeout (マスターノードがリクエストを処理するのを待つ時間、デフォルト： 30s) および timeout (確認応答または現在の結果を待つ時間、デフォルト： 30s) を使用します。管理リクエストが acknowledged=false を返すかタイムアウトした場合でも、サーバー側の操作がロールバックされたとは限りません。再試行する前に、リソースの現在の状態をクエリしてください。

    コレクションとスライスの API クイックリファレンス

    次の表は、コレクションとスライス関連のパブリック API を目的別にまとめたもので、内部プラットフォームのメンテナンス API は除外されています。コレクション、スライス、バッキング、Copy Slice、Branch Slice、およびスライスウォームアップのエンドポイントは Agent Engine エディションの拡張機能であり、コレクション、バッキング、スライスの監視エンドポイントも同様です。残りのエンドポイントは標準の Elasticsearch API です。「API」列では、角括弧はオプションのパスセグメントを囲み、中括弧は独自の値に置き換えるプレースホルダーを囲みます。この表を使用して特定のタスクのエンドポイントを検索し、操作別の API の表を使用してそのタスクの詳細ページにアクセスしてください。

    目的

    API

    コレクションの作成

    PUT /_slice_collection/{collection}

    コレクションの取得

    GET /_slice_collection[/{collection}]

    コレクションの更新

    POST /_slice_collection/{collection}/_update

    コレクションの削除

    DELETE /_slice_collection/{collection}

    スライスの登録

    PUT /_slice_collection/{collection}/slices/{slice}

    スライスの一括登録

    PUT /_slice_collection/{collection}/slices

    単一スライスのクエリ

    GET /_slice_collection/{collection}/slices/{slice}

    スライスの一覧表示 (ページネーション付き)

    GET /_slice_collection/{collection}/slices

    スライスの削除

    DELETE /_slice_collection/{collection}/slices/{slice}

    バッキングの事前作成

    PUT /_slice_collection/{collection}/backings?count={count}

    単一ドキュメントの読み取りと書き込み

    /{collection}/_doc/{id}、/{collection}/_create/{id}、/{collection}/_update/{id}、/{collection}/_source/{id}。ID を自動生成するには、POST /{collection}/_doc を使用します。ドキュメントが存在するかどうかを確認するには、HEAD /{collection}/_doc/{id} を使用します

    一括での書き込みと読み取り

    POST /_bulk、POST /{collection}/_bulk、POST /{collection}/_mget

    検索とカウント

    POST /{collection}/_search、POST /{collection}/_count、POST /_msearch、POST /{collection}/_msearch

    検索テンプレートの実行、非同期検索の管理、クエリの検査または検証

    POST /{collection}/_search/template、POST /{collection}/_async_search、GET /_async_search/{id}、DELETE /_async_search/{id}、POST /{collection}/_validate/query、GET /{collection}/_search_shards、POST /{collection}/_explain/{id}

    クエリによる更新または削除

    POST /{collection}/_update_by_query、POST /{collection}/_delete_by_query

    リインデックス

    POST /_reindex

    マッピングの更新

    PUT /{collection}/_mapping

    動的設定の更新

    PUT /{collection}/_settings

    明示的なリフレッシュ

    POST /{collection}/_refresh

    スライスキャッシュのウォームアップ

    POST /{collection}/_warm_slice?_slice={slice}

    ウォームアップタスクのクエリ

    GET /_tasks/{taskId}

    コレクションエイリアスの管理

    POST /_aliases、GET /_alias[/{alias}]

    Copy Slice の開始

    POST /_slice_collection/{collection}/slices/{source}/_copy/{target}

    Copy Slice ステータスのクエリ

    GET /_slice_collection/{collection}/_copy/{copy_id}

    Copy Slice のキャンセル

    POST /_slice_collection/{collection}/_copy/{copy_id}/_cancel

    Branch Slice の作成 (ベータ版)

    PUT /_slice_collection/{collection}/slices/{source}/_branch/{target}

    コレクションの実行ステータスの表示

    GET /_cat/slice_collection[/{name}]

    バッキングの実行ステータスの表示

    GET /_cat/slice_collection/{collection}/backings[/{backing}]

    スライスの実行ステータスの表示

    GET /_cat/slice_collection/{collection}/slices[/{slice}]

    クラスターとノードの監視

    GET /_cluster/health、GET /_nodes/stats、GET /_tasks