Data Query 개요

Prev Next

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

Data Query는 대규모의 정형 또는 비정형 데이터를 간편하게 분석할 수 있는 네이버 클라우드 플랫폼의 서버리스 대화형 쿼리 서비스입니다. 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 네이버 클라우드 플랫폼에서 발급받은 Access Key
x-ncp-apigw-signature-v2 Required 네이버 클라우드 플랫폼에서 발급받은 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 프로젝트 아이디 오류 쿼리 실행 프로젝트 아이디 확인
  • 쿼리 실행 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 서브 계정에 액션 권한 없음 서브 계정 권한 확인
참고

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 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에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.