Data Queryの概要

Prev Next

VPC環境で利用できます。

Data Queryは、大規模な定型または非定型データを簡単に分析できる NAVERクラウドプラットフォームのサーバーレス会話型クエリサービスです。Data Queryサービスは、クエリの実行および照会機能関連の APIを RESTfulの形式で提供します。

Data Queryの共通設定

Data Query APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://kr.dataquery.naverncp.com

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • Unix Timestamp形式
x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名
Content-Type Optional リクエストデータの形式
  • application/json

レスポンス

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

レスポンスボディ

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

Error
Errorは API呼び出し失敗情報を定義します。Errorの説明は次の通りです。

フィールド タイプ 必須の有無 説明
type String - リクエスト URL
title String - エラータイプ
status Integer - HTTPステータスコード
detail String - エラー状態メッセージ
instance String - エラーインスタンス URI
errorCode Integer - エラー状態コード

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

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明 解決策
400 400
  • Catalog 'public_data1' does not exist
  • Schema 'public_schema' does not exist
 クエリ文エラー クエリ文とテーブル情報を再度確認
400 10010 Query Project Not Found プロジェクト IDエラー クエリ実行プロジェクト IDを確認
  • クエリ実行 APIの場合、Data Queryサービスの申し込み状況を確認
400 10090 mismatched input 'table'. Expecting: <identifier> クエリ構文エラー クエリ構文を再度確認
400 10091 'DropCatalog' command is blocked. 使用できないクエリ文 クエリ構文を確認し、クエリ文を変更
401 10002 Authentication Failed - This account is not allowed 認証失敗 リクエストヘッダの認証情報を確認
403 10001 Change/executeSelectQuery サブアカウントにアクション権限がない サブアカウントの権限を確認
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
    "type": "http://kr.dataquery.naverncp.com/api/v2/queries",
    "title": "query.error.BAD_REQUEST",
    "status": 400,
    "detail": "[query] must not be null",
    "instance": "/api/v2/queries",
    "errorCode": 400
}

Data Query API

Data Queryサービスが提供する APIの説明は次の通りです。

API 説明
クエリの実行 ユーザークエリを実行
クエリの非同期実行 ユーザークエリを非同期で実行
クエリ結果の照会 ユーザークエリ実行結果を照会
クエリ履歴の照会 ユーザークエリ実行履歴を照会
クエリのキャンセル ユーザークエリの実行をキャンセル

Data Query関連リソース

Data Query APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。