クエリの非同期実行

Prev Next

VPC環境で利用できます。

クエリを非同期で実行します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v2/queries/async

リクエストヘッダ

Data Query APIで共通して使用されるヘッダの詳細は、Data Queryのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
query String Required 実行クエリ文
executionParameters Array Optional クエリ実行パラメータ
isReuse Boolean Optional クエリ結果を再利用するか
  • true | false
    • true: 再利用
    • false: 再利用しない
reuseMaxAge Integer Conditional クエリ結果の再利用最大有効期間(分)
  • 1~10080 (デフォルト: 60)
  • isReuseがtrueの場合、必ず入力
  • <例> 60を入力した場合: クエリ実行時から60分以内に返すことのできる有効な結果が存在する場合、その結果を再利用
dataSource String Optional クエリ実行データソース名
database String Optional クエリ実行データベース名

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://kr.dataquery.naverncp.com/api/v2/queries/async' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "query": "SELECT * FROM public_data.korea_trade_insurance.exchange_rate",
    "isReuse": false
}'

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
id String - 実行 ID
columns Array - カラム情報
data Array - クエリの実行結果
offset Long - ページ照会に使用するオフセット
  • isFinishedがfalseの場合、次のページ照会のリクエストに使用
isFinished Boolean - 全ページ照会が完了しているか
  • true | false
    • true: 完了 (次のページが存在しない)
    • false: 完了していない (次のページが存在)

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

Data Query APIで共通して使用されるレスポンスステータスコードの詳細は、Data Queryのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "id": "dc82c8a8-****-****-****-990cb114e172",
    "columns": [],
    "data": [],
    "offset": 0,
    "isFinished": false
}