쿼리 비동기 실행

Prev Next

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

쿼리를 비동기로 실행합니다.

요청

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

메서드 URI
POST /api/v2/queries/async

요청 헤더

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
query String Required 실행 쿼리문
executionParameters Array Optional 쿼리 실행 파라미터
isReuse Boolean Optional 쿼리 결과 재사용 여부
  • true | false
    • true: 재사용
    • false: 재사용 안 함
reuseMaxAge Integer Conditional 쿼리 결과 재사용 허용 시간(분)
  • 1~10080 (기본값: 60)
  • isReuse가 true인 경우, 필수 입력
  • <예시> 60을 입력한 경우: 쿼리 실행 시점으로부터 60분 전에 반환 가능한 유효 결과 존재 시 해당 결과 재사용
dataSource String Optional 쿼리 실행 데이터 소스 이름
database String Optional 쿼리 실행 데이터베이스 이름

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://kr.dataquery.naverncp.com/api/v2/queries/async' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "query": "SELECT * FROM public_data.korea_trade_insurance.exchange_rate",
    "isReuse": false
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
id String - 실행 아이디
columns Array - 컬럼 정보
data Array - 쿼리 실행 결과
offset Long - 페이지 조회 시 사용할 오프셋
  • isFinished가 false인 경우, 다음 페이지 조회 요청에 사용
isFinished Boolean - 전체 페이지 조회 완료 여부
  • true | false
    • true: 완료 (다음 페이지 존재 안 함)
    • false: 미완료 (다음 페이지 존재)

응답 상태 코드

Data Query API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Query 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "id": "dc82c8a8-****-****-****-990cb114e172",
    "columns": [],
    "data": [],
    "offset": 0,
    "isFinished": false
}