クエリ結果の照会

Prev Next

VPC環境で利用できます。

クエリの実行結果を照会します。

リクエスト

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

メソッド URI
GET /api/v2/queries/{executionId}

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
executionId String Required クエリ ID

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
offset Long Optional ページ照会に使用するオフセット (デフォルト: 0)
pageSize Integer Optional ページごとの項目数
  • 1~1000 (デフォルト: 100)

リクエスト例

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

curl --location --request GET 'https://kr.dataquery.naverncp.com/api/v2/queries/eab65f48-****-****-****-c87f0db59b49' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
id String - 実行 ID
columns Array - カラム情報: Column
data Array - クエリの実行結果
  • 各行がColumnのカラム順序と1対1マップされた配列で返す
  • 複合型(row)カラムの場合、{フィールド名=値}形式の文字列でシリアル化
    • 2個以上返す場合はコンマ「,」で区切る
offset Long - ページ照会に使用するオフセット
  • isFinishedがfalseの場合、次のページ照会のリクエストに使用
isFinished Boolean - 全ページ照会が完了しているか
  • true | false
    • true: 完了 (次のページが存在しない)
    • false: 完了していない (次のページが存在)

Column

Columnの説明は次の通りです。

フィールド タイプ 必須の有無 説明
name String - カラム名
type String - カラムタイプ
typeSignature Object - カラムタイプ情報
typeSignature.rawType String - 基本タイプ名
typeSignature.arguments Array - タイプパラメータリスト: ClientTypeSignatureParameter

ClientTypeSignatureParameter

ClientTypeSignatureParameterの説明は次の通りです。

フィールド タイプ 必須の有無 説明
kind String - タイプパラメータの種類
  • TYPE | NAMED_TYPE | LONG | VARIABLE
value Union - タイプパラメータ値
  • Object | Number | String
    • Object: kindがTYPEまたはNAMED_TYPEの場合(複合型)
    • Number: kindがLONGの場合
    • String: kindがVARIABLEの場合
value.fieldName Object - 複合型のフィールド名オブジェクト
value.fieldName.name String - フィールド名
value.typeSignature Object - 複合型のフィールドタイプオブジェクト
value.typeSignature.rawType String - 基本タイプ名
value.typeSignature.arguments Array - タイプパラメータリスト: ClientTypeSignatureParameter

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

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

レスポンス例

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

{
    "id": "eab65f48-****-****-****-c87f0db59b49",
    "columns": [
        {
            "name": "date",
            "type": "varchar",
            "typeSignature": {
                "rawType": "varchar",
                "arguments": [
                    {
                        "kind": "LONG",
                        "value": 2147483647
                    }
                ]
            }
        },
        {
            "name": "area_name",
            "type": "varchar",
            "typeSignature": {
                "rawType": "varchar",
                "arguments": [
                    {
                        "kind": "LONG",
                        "value": 2147483647
                    }
                ]
            }
        },
        {
            "name": "fine_dust_per_day",
            "type": "varchar",
            "typeSignature": {
                "rawType": "varchar",
                "arguments": [
                    {
                        "kind": "LONG",
                        "value": 2147483647
                    }
                ]
            }
        }
    ],
    "data": [
        [
            "202211302300",
            "downtown",
            "67"
        ],
        [
            "202211302300",
            "downtown",
            "100"
        ],
        [
            "202211302300",
            "downtown",
            "68"
        ],
        ...
    ],
    "offset": 596,
    "isFinished": true
}