REST API 概要¶
本サービスが提供するAPIはREST (Representational State Transfer) をサポートしており、全てのAPIはJSON形式のレスポンスボディを返します。
基本リクエストヘッダー¶
本サービスはリクエストの基本ヘッダーとして以下の情報を処理します。
本サービスのREST APIに対して送信されるリクエストには以下のヘッダーを含めなければならなりません。
なお、以下の表で必須項はリクエスト側での設定が必須かどうかを指しており、○は必須、×は必須ではない、△は条件により必須を意味します。
またデフォルト値が「なし」と記載されている箇所は、デフォルト値が存在しない事を意味し、null値や空文字列がデフォルト値であるという意味ではありません。
| HTTPヘッダー | 説明 | 必須 |
|---|---|---|
| Authorization |
|
○ |
| Content-Length |
|
△ |
| Content-Type |
|
× |
| Date |
|
○ |
| Host |
|
△ |
基本レスポンスヘッダー¶
本サービスはレスポンスの基本ヘッダーとして以下の情報を返します。
本サービスのREST APIから送信されるレスポンスには必ず以下のヘッダーが含まれます。
なお、デフォルト値が「なし」と記載されている箇所は、デフォルト値が存在しないことを意味し、null値や空文字列がデフォルト値であるという意味ではありません。
| HTTPヘッダー | 説明 |
|---|---|
| Content-Length |
|
| Connection |
|
| Date |
|
| Server |
|
| x-iijgio-request-id |
|
エラーレスポンス¶
リクエストに問題がある場合、または、本サービスのサーバサイドで問題が発生した場合は、以下に示すエラーレスポンスを返します。
Note
- エラーレスポンスはJSON形式で返され、Content-Typeヘッダーは
application/jsonとなります。 - ステータスコードは400、500番台が返され、400番台はリクエストに問題があることを示し、500番台はサーバサイドで問題が発生したことを示します。
サンプル
{
"code": "NotFound",
"message": "Not Found",
"requestId": "59ACA14FEB2845EF9E5C141B1F7E47DD",
"resource": "/nosuch_resource",
"status": 404
}
レスポンスボディ¶
| 名前 | 説明 | ||
|---|---|---|---|
| code |
|
||
| message |
|
||
| requestId |
|
||
| resource |
|
||
| status |
|
API 一覧¶
解析オプションAPI を介し、解析オプションの操作が可能です。API には、以下のものがあります。
| 名前 | 概要 |
|---|---|
| クラスタ再起動 | クラスタの再起動を行います。 |
| クラスタ一覧取得 | 保有しているクラスタの一部または全てを一覧として取得します。 |
| クラスタ情報取得 | 指定したクラスタの情報を取得します。 |
| クラスタ統計情報取得 | 指定したクラスタの統計情報を取得します。 |
| クラスタログ出力 | 指定したクラスタのアプリケーションログをストレージへ出力します。 |
| 名前 | 概要 |
|---|---|
| データベース作成 | データベースを作成します。 |
| データベース一覧取得 | データベースの一部または全てを一覧として取得します。 |
| データベース削除 | データベースを削除します。 |
| 名前 | 概要 |
|---|---|
| テーブル作成 | テーブルを作成します。 |
| テーブル一覧取得 | 指定したデータベースが保有するテーブルの一部または全てを一覧として取得します。 |
| テーブル情報取得 | 指定したテーブルの情報を取得します。 |
| テーブル削除 | テーブルを削除します。 |
| 名前 | 概要 |
|---|---|
| クエリ発行(HiveQL) | HiveQLクエリを発行します。 |
| クエリ発行(Split) | Splitクエリを発行します。 |
| クエリ一覧取得 | 指定したクラスタが保持するクエリ情報の一部または全てを一覧として取得します。 |
| クエリ情報取得 | 指定したクエリの情報を取得します。 |
| クエリキャンセル | クエリの実行を中止します。 |
| クエリログ取得 | クエリのログを取得します。 |