오류 처리

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

Ncloud API 표준 규격을 적용한 API입니다.

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

오류 코드

응답 상태 코드에 대한 설명은 다음과 같습니다. HTTP 상태 코드는 응답 헤더에 포함되며, 오류 코드는 응답 바디에 포함됩니다. 하나의 HTTP 상태 코드에 여러 오류 코드가 대응될 수 있으므로 오류를 처리할 때는 HTTP 상태 코드와 오류 코드를 함께 확인해 주십시오.

성공

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

클라이언트 오류

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

서버 오류

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

오류 응답 바디

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

fieldErrors

fieldErrors에 대한 설명은 다음과 같습니다.

오류 응답 예시

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

• 기본 오류 응답

  {
    "error": {
      "errorCode": "NotFound",
      "message": "One or more of the resources in the request do not exist in the system."
    }
  }
  

• 입력값이 유효하지 않은 필드가 2개 이상인 경우: fieldErrors에 각 필드의 오류 정보 반환

  {
    "error": {
      "errorCode": "InvalidParameter",
      "message": "The specified parameter is invalid.",
      "fieldErrors": [
        {
          "field": "name",
          "message": "Name must be at least 3 characters long"
        },
        {
          "field": "age",
          "message": "age is required"
        }
      ]
    }
  }