REST API 概要

本サービスが提供するAPIはREST (Representational State Transfer) をサポートしており、全てのAPIはJSON形式のレスポンスボディを返します。

基本リクエストヘッダー

本サービスはリクエストの基本ヘッダーとして以下の情報を処理します。

本サービスのREST APIに対して送信されるリクエストには以下のヘッダーを含めなければならなりません。

なお、以下の表で必須項はリクエスト側での設定が必須かどうかを指しており、○は必須、×は必須ではない、△は条件により必須を意味します。

またデフォルト値が「なし」と記載されている箇所は、デフォルト値が存在しない事を意味し、null値や空文字列がデフォルト値であるという意味ではありません。

表. 基本リクエストヘッダー一覧
HTTPヘッダー 説明 必須
Authorization
リクエスト認証に用いる文字列
型: String
デフォルト値: なし
Content-Length
RFC 2616に準拠したヘッダー部を除いたメッセージ長
型: String
デフォルト値: なし
条件: PUTリクエストにおいて必須です。
Content-Type
リソースのコンテントタイプ
例:text/plain

型: String
デフォルト値: なし
×
Date
リクエスト側で生成した現在日時
例: Wed 01 Mar 2009 12:00:00 GMT

型: String
デフォルト値: なし
Host
対象となるリソースのホスト
固定的に「analysis-dag.iijgio.com」となります。

型: String
デフォルト値: なし
条件: HTTP/1.1リクエストの場合必須。HTTP/1.0リクエストの場合任意です。

基本レスポンスヘッダー

本サービスはレスポンスの基本ヘッダーとして以下の情報を返します。

本サービスのREST APIから送信されるレスポンスには必ず以下のヘッダーが含まれます。
なお、デフォルト値が「なし」と記載されている箇所は、デフォルト値が存在しないことを意味し、null値や空文字列がデフォルト値であるという意味ではありません。
表. 基本レスポンスヘッダー一覧
HTTPヘッダー 説明
Content-Length
レスポンスのボディの長さ(サイズ)
型: String
デフォルト値: なし
Connection
サーバとの接続コネクションが開いているかどうか
型: 列挙
有効な値: open | close
デフォルト値: なし
Date
サーバがレスポンスを返した日時
(サーバ側で生成されます。)

例 Wed, 01 Mar 2009 12:00:00 GMT
型: String
デフォルト値: なし
Server
このレスポンスを生成したサーバ名
型: String
デフォルト値: なし
x-iijgio-request-id
サーバ側が一意に生成する識別子
問題が発生した場合に利用する為の値です。

型: String
デフォルト値: なし

エラーレスポンス

リクエストに問題がある場合、または、本サービスのサーバサイドで問題が発生した場合は、以下に示すエラーレスポンスを返します。

Note

  • エラーレスポンスはJSON形式で返され、Content-Typeヘッダーはapplication/jsonとなります。
  • ステータスコードは400、500番台が返され、400番台はリクエストに問題があることを示し、500番台はサーバサイドで問題が発生したことを示します。

サンプル

{
    "code": "NotFound",
    "message": "Not Found",
    "requestId": "59ACA14FEB2845EF9E5C141B1F7E47DD",
    "resource": "/nosuch_resource",
    "status": 404
}

レスポンスボディ

表. エラーレスポンスボディ要素一覧
名前 説明
code
エラー状態をユニークに表す文字列

プログラムによって解釈できるようにするための値です。

型:String
message
エラーの状態の一般的な説明
code とは異なりこちらは人が解釈するための要素です。
英語で記載されているため、国際化対応をする場合はこのメッセージをそのまま使うことはできません。
型:String
requestId
エラーに関連するリクエストの識別子
型:String
resource
エラーに関連するリソース

リクエストURLで指定されたリソースを表示します。

型:String
status
HTTPステータスコード
型:Integer

エラーコード

エラーレスポンスにはエラーの内容を示すエラーコードが含まれています。エラーコードについては以下をご覧ください。

認証

本サービスが提供するAPIは以下の認証をサポートしています。

API 一覧

解析オプションAPI を介し、解析オプションの操作が可能です。API には、以下のものがあります。

表. クラスタAPI一覧
名前 概要
クラスタ再起動 クラスタの再起動を行います。
クラスタ一覧取得 保有しているクラスタの一部または全てを一覧として取得します。
クラスタ情報取得 指定したクラスタの情報を取得します。
クラスタ統計情報取得 指定したクラスタの統計情報を取得します。
クラスタログ出力 指定したクラスタのアプリケーションログをストレージへ出力します。
表. データベースAPI一覧
名前 概要
データベース作成 データベースを作成します。
データベース一覧取得 データベースの一部または全てを一覧として取得します。
データベース削除 データベースを削除します。
表. テーブルAPI一覧
名前 概要
テーブル作成 テーブルを作成します。
テーブル一覧取得 指定したデータベースが保有するテーブルの一部または全てを一覧として取得します。
テーブル情報取得 指定したテーブルの情報を取得します。
テーブル削除 テーブルを削除します。
表. クエリAPI一覧
名前 概要
クエリ発行(HiveQL) HiveQLクエリを発行します。
クエリ発行(Split) Splitクエリを発行します。
クエリ一覧取得 指定したクラスタが保持するクエリ情報の一部または全てを一覧として取得します。
クエリ情報取得 指定したクエリの情報を取得します。
クエリキャンセル クエリの実行を中止します。
クエリログ取得 クエリのログを取得します。

ページ先頭へ