오류 처리

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

Legacy API 호출 실패 시 제공되는 오류 코드와 메시지 정보, 응답 구조를 설명합니다.

참고

서비스별 오류 코드와 발생 조건은 각 서비스 API 가이드의 응답 상태 코드를 참조해 주십시오.

오류 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

성공

호출이 성공한 경우의 상태 코드는 다음과 같습니다. 오류에 대한 조치가 필요 없습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	OK	요청 성공
201	-	Created	요청의 결과로 새로운 리소스가 생성됨
202	-	Accepted	요청이 수락되었지만 아직 완료되지 않았음

클라이언트 오류

클라이언트 오류로 인해 호출이 실패한 경우의 상태 코드는 다음과 같습니다. 메시지를 확인하여 사용자 조치 후 다시 시도해 주십시오.

HTTP 상태 코드	코드	메시지	설명
400	100	Bad Request Exception	protocol(https), endocing(UTF-8) 등 Request 오류
401	200	Authentication Failed	인증 실패
401	210	Permission Denied	권한 없음
404	300	Not Found Exception	권한 없음
429	400	Quota Exceeded	Quota 초과
429	410	Throttle Limited	Rate 초과
429	420	Rate Limited	Rate 초과
413	430	Request Entity Too Large	요청 엔티티 크기 초과

서버 오류

서버 오류로 인해 호출이 실패한 경우의 상태 코드는 다음과 같습니다. 메시지를 확인하여 관리자 또는 네이버 클라우드 플랫폼에 문의해 주십시오.

HTTP 상태 코드	코드	메시지	설명
503	500	Endpoint Error	엔드포인트 연결 오류
504	510	Endpoint Timeout	엔드포인트 연결 시간 초과
500	900	Unexpected Error	예외 처리가 안된 오류

오류 응답 바디

호출이 실패한 경우의 응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`error`	Object	-	호출 오류 정보
`error.errorCode`	Integer	-	오류 코드
`error.message`	String	-	오류 메시지

오류 응답 예시

호출이 실패한 경우의 예시는 다음과 같습니다.

Content-type: application/json

{
 "error":{
    "errorCode":"210",
    "message":"Permission Denied"
  }
 }

Content-type: application/xml

<?xml version='1.0' encoding='UTF-8' ?>
<Message>
    <error>
     <errorCode>210</errorCode>
     <message>Permission Denied</message>
 </error>
</Message>