쿼리 결과 다운로드 토큰 생성

쿼리 결과 다운로드를 위한 토큰을 발급받은 후, 파일 다운로드 API를 사용해 쿼리 결과를 다운로드할 수 있습니다. 발급된 토큰은 1회만 사용 가능하며, 30분 후 만료됩니다. 대상 쿼리는 커서 생성 API로 실행한 쿼리여야 합니다.

필요 권한

사용자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
    -d "filename=my_query.csv" \
    -X POST "https://HOSTNAME/api/sonar/cursors/1234/download-token"

요청 매개변수

경로 매개변수

요청 본문 매개변수

• split_count를 사용하면 여러 개의 CSV 파일이 zip 압축 파일로 묶여서 다운로드됩니다. 이 경우 filename 매개변수 값은 확장자로 zip을 사용해야 합니다. (예시: filename=result.zip)

지원하는 파일 형식 및 문자 인코딩을 표로 정리하면 다음과 같습니다.

정상 응답

HTTP 상태 코드 200 응답

{ "token": "4ba40c97-b31b-450f-8af8-ceb1b94f5514" }

• token (문자열): 발급된 다운로드 토큰 GUID

오류 응답

쿼리 id가 정수가 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "illegal-argument",
  "error_msg": "id should be integer type."
}

filename 입력 값이 없거나 유효하지 않은 경우

HTTP 상태 코드 400 응답

{
  "error_code": "illegal-argument",
  "error_msg": "invalid file name: null"
}

offset, limit 값이 64비트 정수가 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "illegal-argument",
  "error_msg": "offset should be long type."
}

offset, limit 값이 음수인 경우

HTTP 상태 코드 400 응답

{
  "error_code": "illegal-argument",
  "error_msg": "offset should be non-negative integer."
}

split_count 값이 32비트 정수가 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "illegal-argument",
  "error_msg": "split_count should be integer type."
}

split_count를 csv 이외의 형식과 함께 사용한 경우

HTTP 상태 코드 400 응답

{
  "error_code": "illegal-argument",
  "error_msg": "'file split' supports only the csv file type."
}

charset에 지원하지 않는 문자 인코딩을 입력한 경우

HTTP 상태 코드 400 응답

{
  "error_code": "illegal-argument",
  "error_msg": "unsupported charset for pdf format: utf-16"
}

지정한 쿼리를 찾을 수 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "generic-error",
  "error_msg": "query not found: 12"
}

filetype에 지원하지 않는 파일 형식을 입력한 경우

HTTP 상태 코드 500 응답

{
  "error_code": "generic-error",
  "error_msg": "invalid file type: txt"
}