クエリ履歴の照会

Prev Next

VPC環境で利用できます。

クエリの実行履歴を照会します。

リクエスト

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

メソッド URI
GET /api/v2/queries

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
status String Optional クエリ状態で絞り込み
  • QUEUED | STARTING | RUNNING | FINISHED | FAILED | CANCELED
    • QUEUED: 待機中
    • STARTING: 実行開始
    • RUNNING: 実行中
    • FINISHED: 実行完了
    • FAILED: 実行失敗
    • CANCELED: 実行をキャンセル
pageNo Integer Optional ページ番号
  • 1~N (デフォルト: 1)
pageSize Integer Optional ページごとの項目数
  • 1~500 (デフォルト: 20)

リクエスト例

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

curl --location --request GET 'https://kr.dataquery.naverncp.com/api/v2/queries?pageNo=1&pageSize=2' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
pageNo Integer - ページ番号
pageSize Integer - ページごとの項目数
hasMore Boolean - 次のページは存在するか
  • true | false
    • true: 存在する
    • false: 存在しない
queryList Array - クエリの実行履歴: QueryHistory

QueryHistory

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

フィールド タイプ 必須の有無 説明
id String - 実行 ID
projectId Integer - クエリ実行プロジェクト ID
query String - 実行クエリ文
status String - クエリの状態
isReuse Boolean - クエリ結果を再利用するか
  • true | false
    • true: 再利用
    • false: 再利用しない
clientType String - クエリリクエストのクライアントタイプ
  • CONSOLE | API
errorMessage String - エラーメッセージ
  • 呼び出しが成功した場合、nullと表示
runTime Number - クエリの実行にかかる時間(ミリ秒)
processDataSize Number - 処理データサイズ
startTime String - クエリ実行開始日時
  • ISO 8601形式

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

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

レスポンス例

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

{
    "pageNo": 1,
    "pageSize": 2,
    "hasMore": true,
    "queryList": [
        {
            "id": "eab65f48-****-****-****-c87f0db59b49",
            "projectId": 309,
            "query": "SELECT date, area_name, fine_dust_per_day\r\nFROM data_catalog.default.a_datacatalog_c512_4c8f9378\r\nWHERE area_name = 'downtown'",
            "status": "FINISHED",
            "isReuse": false,
            "clientType": "CONSOLE",
            "errorMessage": null,
            "runTime": 827,
            "processDataSize": 2783,
            "startTime": "2025-07-14T04:17:24.501+00:00"
        },
        {
            "id": "d7d1c896-****-****-****-1abcd2f816a2",
            "projectId": 309,
            "query": "SELECT date, area_name, fine_dust_per_day\r\nFROM data_catalog.default.a_datacatalog_c512_4c8f9378\r\nWHERE area_name = 'downtown'",
            "status": "FINISHED",
            "isReuse": false,
            "clientType": "CONSOLE",
            "errorMessage": null,
            "runTime": 268,
            "processDataSize": 2783,
            "startTime": "2025-07-14T02:43:14.411+00:00"
        }
    ]
}