Alibaba Cloud Elasticsearch は、HTTP 経由でオープンソースの Elasticsearch RESTful API をサポートしており、標準の HTTP リクエストを通じてドキュメント操作、インデックス管理、エイリアス構成にアクセスできます。
アクセス方法
Elasticsearch は、ポート 9200 で HTTP 経由のリクエストを受け付けます。TCP アクセスもサポートされています。以下のアクセス方法が利用可能です:
| 方法 | 説明 | 利用シーン |
|---|---|---|
| curl | コマンドラインから直接 HTTP リクエストを送信 | クイックテスト、スクリプト、CI パイプライン |
| Java REST クライアント | 公式の Elasticsearch Java クライアント | Java アプリケーション (推奨) |
| Java API (Transport Client) | TCP トランスポートに基づくレガシー Java クライアント | Elasticsearch 5.x または 6.x の既存のコードベースのみ |
curl を使用した API の呼び出し
ご利用のクラスターの内部またはパブリックエンドポイントのポート 9200 にリクエストを送信します。リクエストパラメーターと実行可能な例については、「curl コマンドと API オペレーションを使用した Alibaba Cloud Elasticsearch クラスターの管理」をご参照ください。
Java クライアントでの接続
Java REST クライアント (推奨)
オープンソースの Elasticsearch が提供する Java REST クライアントを使用します。クライアントバージョンは、ご利用のクラスターの Elasticsearch バージョンと一致させる必要があります。バージョンが一致しない場合、クライアントはクラスターを識別できません。
Java クライアントのオプションと互換性の概要については、「Java クライアントの概要」をご参照ください。
Java API (Transport Client)
Alibaba Cloud Elasticsearch には、Transport Client と Java REST クライアントの両方がプリインストール済みです。Transport Client は Elasticsearch 7.0 で非推奨となり、Elasticsearch 8.0 で削除されました。
Java API リファレンスドキュメントについては、「Java API」をご参照ください。
ドキュメント API
ドキュメント API は、個別または複数のドキュメントを操作します。バッチ操作の場合は、可能な限り複数ドキュメント API を使用してください。
単一ドキュメント API
| API | 説明 |
|---|---|
| Index API | インデックス内のドキュメントを作成または置き換え |
| Get API | ID でドキュメントを取得 |
| Delete API | ID でドキュメントを削除 |
| Update API | ドキュメントを部分的に更新 |
複数ドキュメント API
| API | 説明 |
|---|---|
| Multi Get API | 単一のリクエストで ID により複数のドキュメントを取得 |
| Bulk API | 単一のリクエストで複数のドキュメントのインデックス作成、更新、または削除を実行 |
| Delete By Query API | クエリに一致するすべてのドキュメントを削除 |
| Update By Query API | クエリに一致するすべてのドキュメントを更新 |
| Reindex API | あるインデックスから別のインデックスにドキュメントをコピー |