쿼리 결과 조회

Prev Next

VPC 환경에서 이용 가능합니다.

쿼리 실행 결과를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /api/v2/queries/{executionId}

요청 헤더

Data Query API에서 공통으로 사용하는 헤더에 대한 정보는 Data Query 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
executionId String Required 쿼리 아이디

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
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 - 실행 아이디
columns Array - 컬럼 정보: Column
data Array - 쿼리 실행 결과
  • 각 행이 Column의 컬럼 순서와 일대일 매핑된 배열로 반환
  • 복합 타입(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
}