目录
此内容是否有帮助?

# データカスタムクエリAPI

クエリキーが生成されると、カスタムクエリAPIを呼び出してプロジェクトデータをクエリできます。参照してOpen APIドキュメントの呼び出しメソッドの説明を参照してください。

# I. SQLクエリ

# SQLクエリ

インターフェイスURL

/querySql?token=xxx&format=json&timeoutSecond=10&sql=select "#country","#province","#city" from v_event_102 where "$part_date"='2018-10-01' limit 200

リクエスト方法

POST

コンテンツタイプ

application/x-www-form-urlencoded

Queryパラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 クエリキー
sql
 select "#country","#province","#city" from v_event_102 where "$part_date"='2018-10-01' limit 200
 String
 はい
 クエリのSQL文
format
 json
 String
 いいえ
 行データフォーマットデフォルトjson
（json、CSv、CSv_ヘッダー、tsv、tsv_ヘッダー）
timeoutSeconds
 10
 Integer
 いいえ
 タイムアウトパラメーターが要求され、タイムアウトするとクエリタスク

成功応答の例

結果は行で区切られ、各行の書式はクエリ文の実行時に指定された書式です。

  1. json形式で結果を返す

形式がjsonの場合、最初の行には状態値とデータメタ情報が含まれ、形式は次のとおりです

{
  "data": { 
      "headers": [
          "#country", 
          "#province", 
          "#city"
      ] 
  },
  "return_code": 0,
  "return_message": "success"
}
パラメーター名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報
data
 -
 Object
 結果を返す
∟ headers ["#country", "#province", "#city"]
 List
 最初の行

クエリ結果が空でない場合は、最初の行の後にデータ行

["中国","甘肃省","兰州市"]
["中国","北京市","北京市"]
["中国","广东省","广州市"]
["中国","甘肃省","兰州市"]

2.その他の形式で結果を返します

形式がcsv_headerまたはtsv_headerの場合、最初の動作列名情報(csv):

"#country","#province","#city"

その後は行為ごとにリストがあり、返された結果(csv)

"中国","甘肃省","兰州市"
"中国","北京市","北京市"
"中国","广东省","广州市"
"中国","甘肃省","兰州市"

3.フォーマットがcsvまたはtsvの場合

結果にはリスト情報はなく、データ内容だけです。

curlの例

curl -X POST 'http://ta2:8992/querySql?token=bTOzKiTIozG4e19FgXphcA8dDV3DIY8RwdHTO7aSnBsRqSNaIk19BnBMecJDWibD' --header 'Content-Type: application/x-www-form-urlencoded' -d 'sql=select+%22%23country%22%2c%22%23province%22%2c%22%23city%22+from+v_event_102+where+%22%24part_date%22%3d%272018-10-01%27+limit+200&format=json&timeoutSecond=10'

# II。SQLページングクエリ

SQLページングクエリAPIには、関連する2つのメソッドが含まれています。第1の方法はクエリ文を実行し、実行終了後に結果のメタ情報とページング情報を返す第2の方法は結果ページングデータ。

# クエリ文の実行

インターフェイスURL

/open/execute-sql?token=xxx&sql=select * from v_user_0 limit 11000&pageSize=10000&format=json&timeoutSeconds=10

リクエスト方法

POST

コンテンツタイプ

application/x-www-form-urlencoded

Queryパラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
sql
 select * from v_user_0 limit 11000
 String
 はい
 クエリのSQL文
format
 json
 String
 いいえ
 行データ形式(json, csv, tsv)、デフォルトjson
pageSize
 10000
 Integer
 いいえ
 ページあたりの行数、最小1000、デフォルト10000
timeoutSeconds
 10
 Integer
 いいえ
 タイムアウトパラメーターが要求され、タイムアウトするとクエリタスク

成功応答の例

{
  "data": {
    "headers": [
      "#user_id",
      "#account_id",
      "#distinct_id",
      "#active_time",
      "#reg_time",
      "#user_operation",
      "#server_time",
      "#is_delete",
      "#update_time",
      "user_level",
      "coin_num",
      "register_time",
      "diamond_num",
      "first_recharge_time"
    ],
    "pageCount": 2,
    "pageSize": 10000,
    "rowCount": 11000,
    "taskId": "119a3a37411f3000"
  },
  "return_code": 0,
  "return_message": "success"
}
パラメーター名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報
data
 -
 Object
 データを返す
∟ pageCount 2
 Integer
 結果データの総ページ数
∟ pageSize 10000
 Integer
 ページあたりの行数
∟ rowCount 11000
 Integer
 結果データの合計行数
∟ header ["#user_id"]
 List
 最初の行のフィールドリスト
∟ taskId 119a3a37411f3000
 String
 タスクID

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1008
 Integer
 リターンコード
return_message
 パラメータ(token)は空です
 String
 戻る情報

curlの例

curl -X POST 'http://ta2:8992/open/execute-sql?token=bTOzKiTIozG4e19FgXphcA8dDV3DIY8RwdHTO7aSnBsRqSNaIk19BnBMecJDWibD' --header 'Content-Type: application/x-www-form-urlencoded' -d 'sql=select%20*%20from%20v_user_0%20limit%2011000&pageSize=10000&format=json&timeoutSeconds=10'

# ダウンロード結果ページデータ

インターフェイスURL

/open/sql-result-page?token=xxx&taskId=119a3a37411f3000&pageId=0

リクエスト方法

GET

コンテンツタイプ

application/json

Queryパラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
taskId
 119a3a37411f3000
 String
 はい
 クエリ
クエリ文
インターフェイスの戻り値戻り値フィールドtaskId
pageId
 0
 Integer
 いいえ
 値の範囲:[0, pageCount-1]、デフォルトは0

返される結果は行ごとに区切られ、各行のデータの形式はクエリ文の実行時に指定された形式

[9324080,"c21756080","c40404080","2019-12-15 16:09:07.000","2019-12-15 16:09:07.000","user_set","2019-12-15 16:22:13.000",false,"2020-06-03 13:10:02.494",6,40000,"2019-12-15 16:09:07.000",0,null]
[9328294,"q21765894","q40422294","2019-12-15 16:19:49.000","2019-12-15 16:19:49.000","user_set","2019-12-15 16:42:18.000",false,"2020-06-03 13:10:02.494",17,642440,"2019-12-15 16:19:49.000",112,"2019-12-15 16:26:13.000"]
[9335719,"t21783319","t40454719","2019-12-15 16:29:45.000","2019-12-15 16:29:45.000","user_set","2019-12-15 16:42:18.000",false,"2020-06-03 13:10:02.494",6,70000,"2019-12-15 16:29:45.000",0,null]

エラー応答の例

{
    "return_code": -1,
    "return_message": "The task is running"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1
 Integer
 リターンコード
return_message
 The task is runningThe task is running
 String
 戻る情報

curlの例

curl -X GET 'http://ta2:8992/open/sql-result-page?token=bTOzKiTIozG4e19FgXphcA8dDV3DIY8RwdHTO7aSnBsRqSNaIk19BnBMecJDWibD&taskId=119a3a37411f3000&pageId=1'

# III。SQL非同期クエリAPI

SQL非同期クエリAPIには、関連する4つのメソッドが含まれています。

  • クエリ文を送信し、クエリのタスクIDを返します。
  • タスクの実行状態を照会します。
  • クエリタスクの結果データ。
  • 終了していないタスクをキャンセルします。

# クエリ文の実行

インターフェイスURL

/open/submit-sql?token=xxx&format=json&sql=select * from v_user_0 limit 11000

リクエスト方法

POST

コンテンツタイプ

application/json

Queryパラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
sql
 select * from v_user_0 limit 11000
 String
 はい
 クエリのSQL文
format
 json
 String
 いいえ
 行データ形式(json, csv, tsv)、デフォルトjson
pageSize
 1000
 Integer
 いいえ
 ページあたりの行数、最小1000、デフォルトではページングしない

成功応答の例

{
  "data": {
    "taskId": "119a3a37411f3000"
  },
  "return_code": 0,
  "return_message": "success"
}
パラメーター名
 サンプル値
 パラメーターの種類
 パラメーターの説明
data
 -
 Object
 結果を返す
∟ taskId 119a3a37411f3000
 String
 タスクID
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1008
 Integer
 リターンコード
return_message
 パラメータ(token)は空です
 String
 戻る情報

curlの例

curl -X POST 'http://ta2:8992/open/submit-sql?token=bTOzKiTIozG4e19FgXphcA8dDV3DIY8RwdHTO7aSnBsRqSNaIk19BnBMecJDWibD' --header 'Content-Type: application/x-www-form-urlencoded' -d 'sql=select%20*%20from%20v_user_0%20limit%2011000&format=json'

# クエリタスクの実行状況

インターフェイスURL

/open/sql-task-info?token=xxx&taskId=119a3a37411f3000

リクエスト方法

GET

コンテンツタイプ

application/json

Queryパラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
taskId
 119a3a37411f3000
 String
 はい
 インターフェイス
クエリ文
実行して結果のtaskIdを返す

成功応答の例

{
  "data": {
    "taskId": "119a3a37411f3000",
    "status": "FINISHED",
    "resultStat": {
        "rowCount": 11000,
        "pageCount": 1,
        "headers": [
          "#user_id",
          "#account_id",
          "#distinct_id",
          "#active_time",
          "#reg_time",
          "#user_operation",
          "#server_time",
          "#is_delete",
          "#update_time",
          "user_level",
          "coin_num",
          "register_time",
          "diamond_num",
          "first_recharge_time"
        ]
     }
  },
  "return_code": 0,
  "return_message": "success"
}
パラメーター名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報
data
 -
 Object
 結果を返す
∟ taskId 119a3a37411f3000
 String
 クエリタスクのIDは、後続のダウンロード結果ページングデータ
∟ status FINISHED
 String
 タスクの状態(RUNNING, FINISHED, FAILED)
∟ resultStat -
 Object
 結果情報は、ステータスがFINISHEDのときに返される
∟ headers ["#user_id"]
 List
 リスト名
∟ rowCount 11000
 Integer
 総行数
∟ pageCount 1
 Integer
 総ページ数

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1008
 Integer
 リターンコード
return_message
 パラメータ(token)は空です
 String
 戻る情報

curlの例

curl -X GET 'http://ta2:8992/open/sql-task-info?token=bTOzKiTIozG4e19FgXphcA8dDV3DIY8RwdHTO7aSnBsRqSNaIk19BnBMecJDWibD&taskId=119a3a37411f3000'

# ダウンロード結果ページングデータ

インターフェイスURL

/open/sql-result-page?token=xxx&taskId=119a3a37411f3000

リクエスト方法

GET

コンテンツタイプ

application/json

Queryパラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
taskId
 119a3a37411f3000
 String
 はい
 インターフェイス
クエリ文
実行して結果のtaskIdを返す
pageId
 0
 Integer
 いいえ
 値の範囲:[0, pageCount-1]、デフォルトは0

返される結果は行ごとに区切られ、各行のデータの形式はクエリ文の実行時に指定された形式

[9324080,"c21756080","c40404080","2019-12-15 16:09:07.000","2019-12-15 16:09:07.000","user_set","2019-12-15 16:22:13.000",false,"2020-06-03 13:10:02.494",6,40000,"2019-12-15 16:09:07.000",0,null]
[9328294,"q21765894","q40422294","2019-12-15 16:19:49.000","2019-12-15 16:19:49.000","user_set","2019-12-15 16:42:18.000",false,"2020-06-03 13:10:02.494",17,642440,"2019-12-15 16:19:49.000",112,"2019-12-15 16:26:13.000"]
[9335719,"t21783319","t40454719","2019-12-15 16:29:45.000","2019-12-15 16:29:45.000","user_set","2019-12-15 16:42:18.000",false,"2020-06-03 13:10:02.494",6,70000,"2019-12-15 16:29:45.000",0,null]

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1008
 Integer
 リターンコード
return_message
 パラメータ(token)は空です
 String
 戻る情報

curlの例

curl -X GET 'http://ta2:8992/open/sql-result-page?token=bTOzKiTIozG4e19FgXphcA8dDV3DIY8RwdHTO7aSnBsRqSNaIk19BnBMecJDWibD&taskId=119a3a37411f3000'

# 終了していないタスクのキャンセル

インターフェイスURL

/open/cancel-sql-task?token=xxx&taskId=119a3a37411f3000

リクエスト方法

POST

コンテンツタイプ

application/json

Queryパラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
taskId
 119a3a37411f3000
 String
 はい
 インターフェイス
クエリ文
実行して結果のtaskIdを返す

成功応答の例

{
  "return_code": 0,
  "return_message": "success"
}

エラー応答の例

{
    "return_code": -1008,
    "return_message": "参数(token)为空"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1008
 Integer
 リターンコード
return_message
 パラメータ(token)は空です
 String
 戻る情報

curlの例

curl -X POST 'http://ta2:8992/open/cancel-sql-task?token=bTOzKiTIozG4e19FgXphcA8dDV3DIY8RwdHTO7aSnBsRqSNaIk19BnBMecJDWibD&taskId=119a3a37411f3000'

← カンバンレポート管理 API →