Search Engine Serviceの概要

Prev Next

VPC環境で利用できます。

Search Engine Serviceは、さまざまな形式のデータを検索、分析、可視化できる管理型 OpenSearchと Elasticsearchサービスの作成・管理をサポートする NAVERクラウドプラットフォームのサービスです。Search Engine Serviceサービスは、Cluster、Dashboard、Monitoring、Snapshot、Import機能関連の APIを RESTful形式で提供します。

Search Engine Serviceの共通設定

Search Engine Service APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://vpcsearchengine.apigw.ntruss.com

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名
Content-type Optional リクエストデータの形式
  • application/json

レスポンス

共通レスポンス形式を説明します。

レスポンスステータスコード

Search Engine Service APIは NAVERクラウドプラットフォームの共通レスポンスステータスコードを使用します。NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

Search Engine Service API

Search Engine Serviceサービスで提供する APIの説明は次の通りです。

Cluster

Cluster関連 APIの説明は次の通りです。

API 説明
アカウントパスワードのリセット Search Engine管理者アカウントのパスワードをリセット
バージョンの照会 使用可能な Search Engineバージョンを照会
バージョンアップ Search Engineのバージョンアップ
バージョンアップ事前チェック Search Engineバージョンアップの事前チェック
バージョンアップ状態の照会 Search Engineバージョンアップの進行状態を照会
サーバの世代の照会 使用可能なノードサーバの世代を照会
サーバタイプの照会 使用可能なノードサーバタイプを照会
サーバタイプの照会(G3) 使用可能なノードサーバタイプを照会(第3世代サーバ専用)
OSタイプの照会 使用可能な OSタイプを照会
OSタイプの照会(G3) 使用可能な OSタイプを照会(第3世代サーバ専用)
認証キーリストの照会 Search Engineクラスタのマネージャノードに SSH接続時に使用される認証キーリストを照会
Subnetリストの照会 使用可能な Subnetリストを照会
Subnetリストの照会(G3) 使用可能な Subnetリストを照会(第3世代サーバ専用)
VPCリストの照会 使用可能な VPCリストを照会
クラスタの作成 Search Engineクラスタを作成
クラスタの作成(G3) Search Engineクラスタを作成(第3世代サーバ専用)
クラスタリストの照会 Search Engineクラスタリストを照会
クラスタの照会 Search Engineクラスタの詳細情報を照会
ACGリストの照会 Search Engineクラスタの ACGルールリストを照会
クラスタの再起動 Search Engineクラスタを再起動
クラスタの削除 Search Engineクラスタを削除
ノードの追加 Search Engineクラスタにデータノードを追加
ノードリストの照会 Search Engineクラスタのノードリストを照会
ノード別変更可能なスペックの照会 Search Engineクラスタのノードごとに変更可能なサーバスペックを照会
ノード別変更可能なスペックの照会(G3) Search Engineクラスタのノードごとに変更可能なサーバスペックを照会(第3世代サーバ専用)
ノードスペックの照会 Search Engineクラスタのノードごとにサーバスペックを照会
ディスク容量の変更 Search Engineクラスタデータノードのサーバディスク容量を変更
ノードスペックの変更 Search Engineクラスタノードのサーバスペックを変更
ノードタイプの変更 Search Engineクラスタデータノードタイプを変更

Dashboard

Dashboard関連 APIの説明は次の通りです。

API 説明
ダッシュボードの照会 Search Engineクラスタのダッシュボードを照会

Monitoring

Monitoring関連 APIの説明は次の通りです。

API 説明
モニタリング結果の照会 Search Engineクラスタとノードサーバのモニタリングデータを照会
OSモニタリング結果の照会 Search Engineノードサーバの OSモニタリングデータを照会

Snapshot

Snapshot関連 APIの説明は次の通りです。

API 説明
バケットリストの照会 Search Engineクラスタのスナップショットが保存可能な Object Storageバケットリストを照会
API認証キーの設定 Object Storageアクセスのための API認証キーを設定
スナップショットの作成 Search Engineクラスタのスナップショットを作成
スナップショット作成履歴の照会 Search Engineクラスタのスナップショット作成履歴を照会
スナップショットスケジューリング設定履歴の照会 Search Engineクラスタのスナップショット作成スケジューリング設定履歴を照会
スナップショットスケジューリングの設定 Search Engineクラスタのスナップショット作成スケジューリングを設定
スナップショットスケジューリング設定の解除 Search Engineクラスタのスナップショット作成スケジューリング設定を解除

Import

Import関連 APIの説明は次の通りです。

API 説明
バケットリストの照会 データの持ち込みが可能な Object Storageバケットリストを照会
データ持ち込みの実行 Object Storageバケットに保存されているデータをクラスタに持ち込みを実行
データ持ち込み履歴の照会 Object Storageバケットに保存されているデータのクラスタへの持ち込み履歴を照会
データ持ち込みの停止 実行中のデータ持ち込みを停止

Search Engine Service関連リソース

Search Engine Service APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。