오류 가이드 v4.0, v3.1 및 v3.0

문서 인텔리전스는 통합 디자인을 사용하여 REST API에서 발생한 모든 오류를 나타냅니다. API 작업이 4xx 또는 5xx 상태 코드를 반환할 때마다 오류에 대한 추가 정보가 다음과 같이 응답 JSON 본문에 반환됩니다.

{
  "error": {
    "code": "InvalidRequest",
    "message": "Invalid request.",
    "innererror": {
      "code": "InvalidContent",
      "message": "The file format is unsupported or corrupted. Refer to documentation for the list of supported formats."
    }
  }
}

여러 오류가 발생할 수 있는 장기 실행 작업의 경우 최상위 오류 코드는 가장 심각한 오류로 설정되며 개별 오류는 error.details 속성 아래에 나열됩니다. 이러한 시나리오에서 각 개별 오류의 대상 속성은 오류의 트리거를 지정합니다.

{
    "status": "failed",
    "createdDateTime": "2021-07-14T10:17:51Z",
    "lastUpdatedDateTime": "2021-07-14T10:17:51Z",
    "error": {
        "code": "InternalServerError",
        "message": "An unexpected error occurred.",
        "details": [
            {
                "code": "InternalServerError",
                "message": "An unexpected error occurred."
            },
            {
                "code": "InvalidContentDimensions",
                "message": "The input image dimensions are out of range. Refer to documentation for supported image dimensions.",
                "target": "2"
            }
        ]
    }
}

최상위 error.code 속성은 다음 오류 코드 메시지 중 하나일 수 있습니다.

가능하면 내부 오류 속성에 자세한 정보가 지정됩니다.