검색 에셋 업로드 상태 조회

Prev Next

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

Presigned URL을 통해 검색용 이미지를 업로드한 후 해당 이미지의 업로드 완료 상태를 확인합니다.

참고

분당 최대 1,000건까지 호출할 수 있습니다. 호출량 조정이 필요한 경우, 고객지원으로 문의해 주십시오.

요청

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

메서드 URI
POST /api/v1/query-assets/uploads/complete

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터는 없습니다.

요청 바디

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

필드 타입 필수 여부 설명
assetKey String Required 업로드 완료 여부를 확인할 이미지 파일의 키 값

요청 예시

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

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/query-assets/uploads/complete' \
--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 '{
  "assetKey": "images/.../query_image.jpg"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code String Required API 처리 결과 코드
message String Required API 처리 결과 메시지
result Object Required 업로드 상태 결과

result

필드 타입 필수 여부 설명
assetKey String Required 업로드된 이미지 파일의 키 값
  • HEIC 형식의 파일인 경우, JPG로 변환된 파일의 키 값이 반환됩니다.
uploadStatus String Required 업로드 상태
  • COMPLETED: 이미지가 정상적으로 업로드됨
  • FAILED: 업로드에 실패함. 실패 사유는 uploadMessage에서 확인
uploadMessage String Optional 업로드 실패 시 상세 메시지
  • FILE_NOT_EXIST: 업로드된 파일을 찾을 수 없음
  • OVER_SIZE_LIMIT: 이미지 파일이 5MB를 초과함
  • RESOLUTION_NOT_SUPPORT: 이미지 해상도가 224px 미만

응답 상태 코드

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

응답 예시

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

{
  "code": "0",
  "message": "success",
  "result": {
    "assetKey": "images/.../query_image.jpg",
    "uploadStatus": "COMPLETED",
    "uploadMessage": null
  }
}