クエリAPI

クエリについての詳細はクエリをご覧ください。

クエリ発行(HiveQL)

HiveQLクエリを実行します。

  • クエリ実行中は、一時ファイルとしてDAGストレージの出力先バケットにtmp_$folder$およびtmp/で始まる複数のオブジェクトが置かれます。

  • 同時に実行可能なクエリの数は、クラスタのインスタンス数 - 1個です。それを超えるクエリを実行しようとした場合はエラーとなります。

  • クエリの実行結果は、 outputResourcePath で指定された場所に出力されます。
    • 実行したクエリの内容によって、複数のオブジェクトが出力されます。
    • outputResourcePath配下に既存オブジェクトが存在する場合、全て削除した上でクエリ結果のオブジェクトを配置します。

クエリ発行(HiveQL)APIについての詳細はクエリ発行(HiveQL)APIをご覧ください。

リクエスト情報

シンタックス

POST /v1/?select HTTP1.1
Host: analysis-dag.iijgio.com
Date: {date}
Authorization: {authorization string}
{
  "label" : {label},
  "outputFormat" : {output data format},
  "outputResourcePath" : {output resource path},
  "query" : {HiveQL},
  "clusterName": {cluster name}
}

リクエストパラメータ

この操作では以下のリクエストパラメータを使用します。

表. クエリ発行(HiveQL) リクエストパラメータ一覧
パラメータ名 説明 必須
clusterName
クエリを実行するクラスタ名
型:String
デフォルト値:なし
制約:45文字以下
query
実行するHiveQL文
型:String
デフォルト値:なし
制約:クエリ発行(HiveQL)APIをご覧ください。
outputResourcePath
出力先のストレージ上のパス
dag:// スキームのURIで指定します。
クエリの実行結果は、当パラメータのオブジェクトキーに該当する部分を接頭辞したオブジェクトを該当するバケットに配置します。
例えば dag://mybucket/analysis/output/ を指定した場合は、mybucket というバケットに analysis/output/000000_0 といったオブジェクトが配置されます。
型:String
デフォルト値:なし
制約:255文字以下のストレージ上のパスをURIで表現した文字列
label
クエリを説明するラベル

実行するクエリの概要や説明を記述し、あとでクエリを識別するためのラベルです。

型:String
デフォルト値:なし
制約:255文字以下の任意の文字列
outputFormat
出力データの形式

クエリが出力するデータの形式を指定します。

型:String
デフォルト値:csv
制約:なし
有効な値:csvまたはtsv
 

レスポンス情報

レスポンスボディ

この操作では以下のレスポンスボディを返します。

表. クラスタ統計情報取得 レスポンスボディ一覧
名前 説明
queryId
クエリを一意に識別するためのID

実行中クエリの情報を取得したり、クエリをキャンセルする際に利用するIDです。

型:Long

エラー情報

この操作では以下のエラーを返します。

表. クエリ発行 (HiveQL) エラーコード一覧
コード 内容 ステータス
InvalidClusterState 操作出来ないクラスタのステータスです。 400 Bad Request
InvalidClusterName 指定されたクラスタ名が不正です。 400 Bad Request
InvalidDatabaseName 指定されたデータベース名が不正です。 400 Bad Request
InvalidTableName 指定されたテーブル名が不正です。 400 Bad Request
InvalidOutputFormat outputFormatに指定された値が不正です。 400 Bad Request
InvalidOutputResourcePath outputResourcePathに指定された値が不正です。 400 Bad Request
LabelIsTooLong 指定されたラベルが長すぎます。 400 Bad Request
TooManyQueries 指定されたクラスタでインスタンス数-1個のクエリが既に実行中です。 400 Bad Request
StorageAccessError ストレージへのアクセスに失敗しました。 400 Bad Request
InvalidDMLStatement 指定されたHiveQL文が不正です。 400 Bad Request
ClusterNotFound 存在しないクラスタ名が指定されました。 404 Not Found
OutputBucketIsNotFound outputResourcePathに指定されたバケットが存在しません。 404 Not Found
InputBucketIsNotFound FROM句に指定されたデータベース名のバケットが存在しません。 404 Not Found

サンプル

sampleCluster1クラスタにHiveQLクエリを投入するサンプル
リクエスト
POST /v1/?select HTTP1.1
Host: analysis-dag.iijgio.com
Content-Length: 233
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
{
  "label" : "サンプルクエリ",
  "outputFormat" : "csv",
  "outputResourcePath" : "dag://sampledb/sample_outdir/",
  "query" : "SELECT time/60, avg(v['size']) FROM sampledb.samletbl GROUP BY 1 ORDER BY 1",
  "clusterName": "sampleCluster1"
}
レスポンス
HTTP/1.1 202 Accepted
Date: Wed, 25 Nov 2009 12:00:00 GMT
Server: IIJAnalysisDag
x-iijgio-request-id: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo
Content-Type: application/json
Content-Length: 30
Connection: close
{
    "queryId" : 2497
}

クエリ発行(Split)

1つ以上の巨大なオブジェクトを100MBごとのオブジェクトに分割し、DAGストレージに出力します。

同じ巨大なオブジェクトを入力としたHiveQLクエリを繰り返し実行する場合、本APIを用いて事前に分割処理を行うことでHiveQLクエリの実行時間を短縮できる場合があります。

クエリ発行(Split)APIについての詳細はクエリ発行(Split)APIをご覧ください。

リクエスト情報

シンタックス

POST /v1/?split HTTP1.1
Host: analysis-dag.iijgio.com
Date: {date}
Authorization: {authorization string}
{
  "label" : {label},
  "inputObjectKeys" : [
      {object key},
      {object key}
  ],
  "inputFormat" : {input format},
  "schema": {schema},
  "outputDatabase" : {output database},
  "outputTable" : {output table},
  "clusterName": {cluster name}
}

リクエストパラメータ

この操作ではリクエストパラメータは使用しません。

リクエストボディ

この操作では以下リクエストボディを使用します。

表. クエリ実行(Split) リクエストボディ一覧
パラメータ名 説明 必須
clusterName
クエリを実行するクラスタ名
型:String
デフォルト値:なし
制約:45文字以下
inputObjectKeys
入力元のストレージ上のパスのリスト

入力とするオブジェクトのキーまたはディレクトリをdag://スキームURIで指定します。

型:StringのArray
デフォルト値:なし
制約:なし
outputDatabase
出力先データベース
結果を出力するデータベースを指定します。
同名のバケットが存在していなければバケットを作成します。
データベースが存在していなければデータベースを作成します。
型:String
デフォルト値:なし
制約:半角英数字で3文字以上63文字以下
outputTable
出力先テーブル
結果を出力するテーブルを指定します。
テーブルが存在していればエラーを返します。
型:String
デフォルト値:なし
制約:半角英数字およびアンダースコアで128文字以下
inputFormat
入力データのフォーマット

クエリが入力とするデータの形式を指定します。

型:String
デフォルト値:csv
制約:なし
有効な値:csv, tsv, jsonのいずれか
schema
作成するテーブルのスキーマ
型:

String

デフォルト値:
  • inputFormatcsv/tsvの場合はv array<string>
  • inputFormatjsonの場合はv map<string, string>
制約:

なし

label
クエリを説明するラベル

実行するクエリの概要や説明を記述し、あとでクエリを識別するためのラベルです。

型:String
デフォルト値:なし
制約:255文字以下の任意の文字列

レスポンス情報

レスポンスボディ

この操作では以下のレスポンスボディを返します。

表. クエリ実行(Split) レスポンスボディ一覧
名前 説明
queryId
クエリを一意に識別するためのID

実行中クエリの情報を取得したり、クエリをキャンセルする際に利用するIDです。

型:Long

エラー情報

この操作では以下のエラーを返します。

表. クエリ発行(Split) エラーコード一覧
コード 内容 ステータス
InvalidClusterState 操作出来ないクラスタのステータスです。 400 Bad Request
InvalidClusterName 指定されたクラスタ名が不正です。 400 Bad Request
InvalidDatabaseName 指定されたデータベース名が不正です。 400 Bad Request
InvalidTableName 指定されたテーブル名が不正です。 400 Bad Request
InvalidInputFormat 指定されたformatの値が不正です。 400 Bad Request
InvalidFormat 指定されたformatの値が不正です。 400 Bad Request
LabelIsTooLong 指定されたラベルが長すぎます。 400 Bad Request
TooManyQueries 指定されたクラスタでインスタンス数-1個のクエリが既に実行中です。 400 Bad Request
StorageAccessError ストレージへのアクセスに失敗しました。 400 Bad Request
InvalidInputObjectKeys inputObjectKeysに指定された値が不正です。 400 Bad Request
InvalidInputFormat 指定されたformatの値が不正です。 400 Bad Request
InvalidSchema 指定されたschemaの値が不正です。 400 Bad Request
InvalidDDLStatement 使用できないschemaが指定されました。 400 Bad Request
OutputTableAlreadyExists outputTableに指定されたテーブルが既に存在します。 400 Bad Request
ClusterNotFound 存在しないクラスタ名が指定されました。 404 Not Found
DatabaseNotFound 存在しないデータベースが指定されました。 404 Not Found
OutputBucketIsNotFound outputResourcePathに指定されたバケットが存在しません。 404 Not Found
InputBucketIsNotFound inputObjectKeysに指定されたバケットが存在しません。 404 Not Found
InputObjectNotFound inputObjectKeysに指定されたオブジェクトが存在しません。 404 Not Found

サンプル

sampleCluster1クラスタにSplitクエリを投入するサンプル
リクエスト
POST /v1/?split HTTP1.1
Host: analysis-dag.iijgio.com
Content-Length: 233
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
{
  "label" : "サンプルクエリ",
  "inputObjectKeys" : [
      "dag://sampledb/sample_input/bigCSVObject1",
      "dag://sampledb/sample_input/bigCSVObject2",
      "dag://sampledb/sample_input/bigCSVObject3"
  ],
  "inputFormat" : "csv",
  "outputDatabase" : "sampledb",
  "outputTable" : "split_tbl",
  "clusterName": "sampleCluster1"
}
レスポンス
HTTP/1.1 202 Accepted
Date: Wed, 25 Nov 2009 12:00:00 GMT
Server: IIJAnalysisDag
x-iijgio-request-id: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo
Content-Type: application/json
Content-Length: 30
Connection: close
{
    "queryId" : 2497
}

クエリ一覧取得

指定された条件に一致するクエリ情報の一覧を取得します。

1度のリクエストで最大 100件のクエリ情報を返すことができ、maxパラメータを変更することで一覧に含まれるクエリの件数(最大100件)を指定できます。

レスポンスに含まれるクエリ情報が、上記で指定した件数を超える場合には、その一覧が部分的であることをisTruncated要素で通知します。

部分的な一覧の場合にはmarkerを指定して、再度リクエストすることで次の一覧を取得できます。

リクエスト情報

シンタックス

GET /v1/?query&max={max-keys}&marker={query marker}&status={status}&type={type}&labelPrefix={label}&clusterNamePrefix={cluster name prefix}&clusterRebooted={cluster rebooted}&order={order} HTTP1.1
Host: analysis-dag.iijgio.com
Date: {date}
Authorization: {authorization string}

リクエストパラメータ

この操作では以下のリクエストパラメータを使用します。

表. クエリ一覧取得 リクエストパラメータ一覧
パラメータ名 説明 必須
max

レスポンスに含める最大クエリ数

型:Integer
デフォルト値:25
制約:1以上100以下の数値
marker
一覧の取得開始位置を指定する文字列
クエリIDを指定します。
orderがascの場合はクエリIDの昇順で後の情報を、
orderがdescの場合にはクエリIDの降順で後の情報を一覧にして返します。
また、marker値に指定されたクエリの情報は返答に含みません。
型:Long
デフォルト値:なし
制約:なし
status
クエリステータスのフィルタ
指定された値のステータスであるクエリのみをレスポンスに含めます。
カンマ区切りで複数指定するとOR条件として指定可能です。
型:String
デフォルト値:なし
制約:なし
type
クエリタイプのフィルタ

指定されたクエリタイプのクエリのみをレスポンスに含めます。

型:String
デフォルト値:なし
制約:なし
有効な値:selectまたはsplit
labelPrefix
ラベルのフィルタ (前方一致)

指定された値と前方一致検索でラベルが一致したクエリのみをレスポンスに含めます。

型:String
デフォルト値:なし
制約:255文字以下
clusterName
レスポンスに含めるクエリ実行クラスタ名
指定された値とクラスタ名が完全一致したクラスタの情報のみをレスポンスに含めます。
本クエリパラメータは clusterNamePrefix と同時には使用できません。
型:String
デフォルト値:なし
制約:45文字以下、clusterNamePrefixが指定されていないこと
clusterNamePrefix
レスポンスに含めるクエリ実行クラスタ名の接頭辞
指定された値と前方一致検索で、クラスタ名が一致したクラスタの情報のみをレスポンスに含めます。
本クエリパラメータは clusterName と同時には使用できません。
型:String
デフォルト値:なし
制約:45文字以下、clusterNameが指定されていないこと
clusterRebooted
投入後にクラスタが再起動済か否かを指定するフィルタ
true なら投入したクラスタが再起動済のクエリのみをレスポンスに含め、
false なら再起動されていないクエリのみレスポンスに含めます。
省略時は両方のクエリをレスポンスに含めます。
型:Boolean
デフォルト値:なし
制約:なし
order
一覧の取得順序

クエリをクエリIDの昇順に並べるか、降順に並べるかを指定します。

型:String
デフォルト値:asc
制約:なし
有効な値:ascまたはdesc
 

リクエストボディ

この操作ではリクエストボディは使用しません。

レスポンス情報

レスポンスボディ

この操作では以下のレスポンスボディを返します。

表. クエリ一覧取得 レスポンスボディ一覧
名前 説明
nextMarker
レスポンスに含まれるクエリの一覧が部分的なものだった場合に、ページングで次の一覧の開始位置を指定するクエリID
型:Integer
isTruncated
結果のクエリの件数がmaxによって指定された数を超えているかどうか
型:Boolean
queries
取得したクエリの一覧
型:クエリ情報ObjectのArray

クエリ情報オブジェクトはtypeごとに異なる項目が設定されます。共通項目とそれぞれのtypeごとに含まれる項目は以下のとおりです。

共通項目
表. クエリ情報オブジェクト共通項目 一覧
名前 説明
id
クエリを一意に識別するためのID
型:Long
type
クエリの種別
型:String
processEngine
クエリを処理する基盤の種別
型:String
dsl
クエリの処理内容を記述するDSL種別
型:String
status
クエリの現在のステータス
型:String
clusterName
クエリを実行したクラスタ名
型:String
accessKeyId
クエリを実行したアクセスキーID
型:String
startTime
クエリを開始した時刻

時刻を日本標準時(GMT-9)で返します。

型:String
時刻フォーマット:YYYY-MM-DD HH:MM:SS
progress
クエリの進捗率
stageがレスポンスに含まれている場合はそのstage全体を100とした進捗率を表し、
stageが含まれない場合にはそのクエリ全体を100とした進捗率を表します。
クラスタから情報が取得出来ない場合は省略されます。
型:Integer
label
ラベル
クエリ実行時に指定したラベルを返します。
ラベル指定が無い場合は省略されます。
型:String
typeがselectの場合
表. クエリ情報オブジェクト typeがselectの場合に含まれる項目一覧
名前 説明
stage
現在実行しているクエリのステージ番号
typeの値がselectのとき、現在実行しているクエリのステージ番号を返します。
クラスタから情報が取得出来ない場合は省略されます。
型:Integer
query
処理内容を記述した文

typeがselectの場合に、HiveQL文の内容を返します。

型:String
typeがsplitの場合

typeがsplitの場合固有の項目はありません。

エラー情報

この操作では以下のエラーを返します。

表. クエリ一覧取得 エラーコード一覧
コード 内容 ステータス
InvalidMaxRange maxの値が範囲外です。 400 Bad Request
InvalidMax maxの値が不正です。 400 Bad Request
InvalidQueryId queryIdの値が不正です。 400 Bad Request
InvalidFilter 指定されたフィルタの値が不正です。 400 Bad Request

サンプル

クエリ情報を最大2クエリ分、昇順に取得するサンプル
リクエスト
GET /v1/?query&max=2&order=asc HTTP1.1
Host: analysis-dag.iijgio.com
Content-Length: 0
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス
HTTP/1.1 200 OK
Date: Wed, 25 Nov 2009 12:00:00 GMT
Server: IIJAnalysisDag
x-iijgio-request-id: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo
Content-Type: application/json
Content-Length: 230
Connection: close
{
  "nextMarker" : 2497,
  "isTruncated" : true,
  "queries" : [
    {
      "id" : 2490,
      "type" : "select",
      "processEngine" : "mapreduce",
      "dsl" : "hive",
      "status" : "running",
      "clusterName" : "sampleCluster1",
      "clusterRebooted" : false,
      "startTime" : "2014-12-19 21:51:10",
      "accessKeyId" : "YOURACCESSKEYID",
      "stage" : 2,
      "progress" : "70%",
      "label" : "任意のラベル",
      "query" : "SELECT count(v['id']) FROM sampledb.sampletbl"
    },
    {
      "id" : 2497,
      "type" : "split",
      "processEngine" : "mapreduce",
      "dsl" : "mapreduce",
      "status" : "running",
      "clusterName" : "sampleCluster1",
      "clusterRebooted" : false,
      "startTime" : "2014-12-19 21:51:10",
      "accessKeyId" : "YOURACCESSKEYID",
      "progress" : "50%",
      "label" : "任意のラベル",
    }
  ]
}

クエリ情報取得

指定されたクエリの情報を取得します。

リクエスト情報

シンタックス

GET /v1/{query id}?query HTTP1.1
Host: analysis-dag.iijgio.com
Date: {date}
Authorization: {authorization string}

リクエストパラメータ

この操作ではリクエストパラメータは使用しません。

リクエストボディ

この操作ではリクエストボディは使用しません。

レスポンス情報

レスポンスボディ

クエリ情報取得APIのレスポンスボディにはtypeごとに異なる項目が設定されます。共通項目とそれぞれのtypeごとに含まれる項目は以下のとおりです。

共通項目
表. クエリ情報取得 レスポンスボディ共通項目一覧
名前 説明
id
クエリを一意に識別するためのID
型:Long
type
クエリの種別
型:String
processEngine
クエリを処理する基盤の種別
型:String
dsl
クエリの処理内容を記述するDSL種別
型:String
status
クエリの現在のステータス
型:String
clusterName
クエリを実行したクラスタ名
型:String
accessKeyId
クエリを実行したアクセスキーID
型:String
startTime
クエリを開始した時刻

時刻を日本標準時(GMT-9)で返します。

型:String
時刻フォーマット:YYYY-MM-DD HH:MM:SS
progress
クエリの進捗率
クエリの進捗率を百分率(パーセント)で示します。
stage がレスポンスに含まれている場合は、そのstageに対しての進捗率を表し、
stage が含まれない場合には、クエリ全体に対する進捗率を表します。
クラスタから情報が取得出来ない場合は省略されます。
型:Integer
label
ラベル
クエリ実行時に指定したラベルを返します。
ラベル指定が無い場合は省略されます。
型:String
typeがselectの場合
表. クエリ情報取得 レスポンスボディ typeがselectの場合に含まれる項目一覧
名前 説明
stage
現在実行しているクエリのステージ番号
type の値が select のとき、現在実行しているクエリのステージ番号を返します。
クラスタから情報が取得出来ない場合は省略されます。
型:Integer
query
処理内容を記述した文
typeselect の場合に、HiveQL文の内容を返します。
型:String
outputFormat
結果の出力形式

typeselectの場合に、結果の出力形式を返します。

型:String
outputResourcePath
結果の出力場所

typeselectの場合に、結果を出力するストレージ上の出力パスを返します。

型:String
typeがsplitの場合
表. クエリ情報取得 レスポンスボディ typeがsplitの場合に含まれる項目一覧
名前 説明
jobId
HadoopのジョブID
typesplit の場合に、そのクエリを実行したジョブのIDを返します。
クラスタログ出力APIで得たログの解析を行う際に使用します。
クラスタから情報が取得出来ない場合は省略されます。
型:String
schema
スキーマ情報

typesplitの場合に、クエリ実行時に指定したスキーマ情報を返します。

型:String
inputObjectKeys
入力元ストレージオブジェクトの一覧

typesplitの場合に、クエリ実行時に指定した入力元オブジェクトの一覧を返します。

型:String の Array
inputFormat
データの形式

typesplitの場合に、クエリ実行時に指定した入力データの形式を返します。

型:String
outputDatabase
出力先データベース名

typesplitの場合に、クエリ実行時に指定した出力先のデータベース名を返します。

型:String
outputTable
出力先テーブル名

typesplitの場合に、クエリ実行時に指定した出力先のテーブル名を返します。

型:String

エラー情報

この操作では以下のエラーを返します。

表. クエリ情報取得 エラーコード一覧
コード 内容 ステータス
InvalidQueryId queryIdの値が不正です。 400 Bad Request
QueryNotFound 存在しないクエリのIDが指定されました。 404 Not Found

サンプル1

typeselect のクエリを取得した場合のサンプル
リクエスト
GET /v1/2497?query HTTP1.1
Host: analysis-dag.iijgio.com
Content-Length: 0
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス
HTTP/1.1 200 OK
Date: Wed, 25 Nov 2009 12:00:00 GMT
Server: IIJAnalysisDag
x-iijgio-request-id: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo
Content-Type: application/json
Content-Length: 230
Connection: close
{
  "id" : 2490,
  "type" : "select",
  "processEngine" : "mapreduce",
  "dsl" : "hive",
  "status" : "running",
  "clusterName" : "sampleCluster1",
  "clusterRebooted" : false,
  "startTime" : "2014-12-19 21:51:10",
  "accessKeyId" : "YOURACCESSKEYID",
  "stage" : 2,
  "progress" : "70%",
  "label" : "任意のラベル",
  "query" : "SELECT count(v['id']) FROM sampledb.sampletbl"
  "outputFormat" : "csv" | "tsv",
  "outputResourcePath" : dag://${bucket}/${outputPath}
}

サンプル2

typesplit のクエリを取得した場合のサンプル
リクエスト
GET /v1/2497?query HTTP1.1
Host: analysis-dag.iijgio.com
Content-Length: 0
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス
HTTP/1.1 200 OK
Date: Wed, 25 Nov 2009 12:00:00 GMT
Server: IIJAnalysisDag
x-iijgio-request-id: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo
Content-Type: application/json
Content-Length: 230
Connection: close
{
  "id" : 2497,
  "type" : "split",
  "processEngine" : "mapreduce",
  "dsl" : "mapreduce",
  "status" : "running",
  "clusterName" : "sampleCluster1",
  "clusterRebooted" : false,
  "startTime" : "2014-12-19 21:51:10",
  "accessKeyId" : "YOURACCESSKEYID",
  "jobId" : "application_1326821518301_0007",
  "progress" : "50%",
  "label" : "任意のラベル",
  "schema" : "int v, string v, map<string string> a",
  "inputObjectKeys" : [
      "dag://sampledb/sample_input/bigCSVObject1",
      "dag://sampledb/sample_input/bigCSVObject2",
      "dag://sampledb/sample_input/bigCSVObject3"
   ],
   "inputFormat" : "csv",
   "outputDatabase" : "sampledb",
   "outputTable" : "split_tbl"
}

クエリキャンセル

実行中のクエリをキャンセルします。

リクエスト情報

シンタックス

DELETE /v1/{query id}?query HTTP1.1
Host: analysis-dag.iijgio.com
Date: {date}
Authorization: {authorization string}

リクエストパラメータ

この操作ではリクエストパラメータは使用しません。

リクエストボディ

この操作ではリクエストボディは使用しません。

レスポンス情報

レスポンスボディ

この操作はレスポンスボディを返しません。

エラー情報

この操作では以下のエラーを返します。

表. クエリキャンセル エラーコード一覧
コード 内容 ステータス
InvalidClusterState 操作出来ないクラスタのステータスです。 400 Bad Request
InvalidQueryId queryIdの値が不正です。 400 Bad Request
InvalidQueryState キャンセル出来ないステータスのクエリが指定されました。 400 Bad Request
QueryNotFound 存在しないクエリのIDが指定されました。 404 Not Found

サンプル

クエリIDが2497のクエリをキャンセルした場合のサンプル
リクエスト
DELETE /v1/2497?query HTTP1.1
Host: analysis-dag.iijgio.com
Content-Length: 0
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス
HTTP/1.1 204 No Content
Date: Wed, 25 Nov 2009 12:00:00 GMT
Server: IIJAnalysisDag
x-iijgio-request-id: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo
Content-Type: text/plain
Content-Length: 0
Connection: close

クエリログ取得

クエリのログを取得します。

クエリ実行(HiveQL)APIにて投入されたselectタイプのクエリのみ、ログが取得できます。

Note

クラスタが再起動された場合は、クエリのログは取得できません。

リクエスト情報

シンタックス

GET /v1/{query id}/log?query HTTP1.1
Host: analysis-dag.iijgio.com
Date: {date}
Authorization: {authorization string}

リクエストパラメータ

この操作ではリクエストパラメータは使用しません。

リクエストボディ

この操作ではリクエストボディは使用しません。

レスポンス情報

レスポンスボディ

この操作では以下のレスポンスボディを返します。

表. クエリログ取得 レスポンスボディ一覧
名前 説明
log
クエリログ

Hiveが返すクエリのログ文字列です。

最大 128KB のログを返します。
ログの総容量が上記のサイズを超える場合は、古いログメッセージから削除されます。
型:String

エラー情報

この操作では以下のエラーを返します。

表. クエリログ取得 エラーコード一覧
コード 内容 ステータス
InvalidClusterState 操作出来ないクラスタのステータスです。 400 Bad Request
InvalidQueryId queryIdの値が不正です。 400 Bad Request
InvalidQueryState キャンセル出来ないステータスのクエリが指定されました。 400 Bad Request
InvalidQueryType ログ取得出来ないタイプのクエリが指定されました。 400 Bad Request
QueryNotFound 存在しないクエリのIDが指定されました。 404 Not Found

サンプル

クエリIDが 2497 のクエリのログを取得した場合のサンプル
リクエスト
GET /v1/2497/log?query HTTP1.1
Host: analysis-dag.iijgio.com
Content-Length: 0
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス
HTTP/1.1 200 OK
x-iijgio-request-id: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo
Date: Wed, 25 Nov 2009 12:00:00 GMT
Server: IIJAnalysisDag
Content-Type: application/json
Content-Length: 230
Connection: close
{
  "log" : "......"
}

ページ先頭へ