錯誤指南 v4.0、v3.1 和 v3.0

發行項
11/19/2024

文件智慧使用統一的設計來顯示在 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 屬性之下。在這類情況下，每個個別錯誤的 target 屬性會指定錯誤的觸發程序。

{
    "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 屬性可以是下列其中一個錯誤碼訊息：

錯誤碼	訊息	Http 狀態
InvalidRequest	要求無效。	400
InvalidArgument	無效引數。	400
禁止	因為原則或其他設定而禁止存取。	403
NotFound	找不到資源。	404
MethodNotAllowed	不允許要求的 HTTP 方法。	405
衝突	因為衝突而無法完成要求。	409
UnsupportedMediaType	不支援要求內容類型。	415
InternalServerError	發生未預期的錯誤。	500
ServiceUnavailable	發生暫時性錯誤。然後再試一次。	503

可能的話，inner error 屬性中會指定更多詳細資料。

最上層錯誤碼	內部錯誤碼	訊息
衝突	ModelExists	具有所提供名稱的模型已經存在。
禁止	AuthorizationFailed	授權失敗：{details}
禁止	InvalidDataProtectionKey	資料保護金鑰無效：{details}
禁止	OutboundAccessForbidden	要求包含不允許的網域名稱或違反目前的存取控制原則。
InternalServerError	未知	未知的誤差。
InvalidArgument	InvalidContentSourceFormat	無效的內容來源：{details}
InvalidArgument	InvalidParameter	參數 {parameterName} 無效：{details}
InvalidArgument	InvalidParameterLength	參數 {parameterName} 長度不能超過 {maxChars} 個字元。
InvalidArgument	InvalidSasToken	共用存取簽章 (SAS) 無效：{details}
InvalidArgument	ParameterMissing	需要參數 {parameterName}。
InvalidRequest	ContentSourceNotAccessible	無法存取內容：{details}
InvalidRequest	ContentSourceTimeout	從用戶端接收檔案時逾時。
InvalidRequest	DocumentModelLimit	帳戶無法建立超過 {maximumModels} 個模型。
InvalidRequest	DocumentModelLimitNeural	帳戶無法每月建立超過 10 個自訂神經模型。請連絡支援來要求更多容量。
InvalidRequest	DocumentModelLimitComposed	帳戶無法建立具有超過 {details} 個元件模型的模型。
InvalidRequest	InvalidContent	檔案已損毀或格式不受支援。請參閱文件中支援的格式清單。
InvalidRequest	InvalidContentDimensions	輸入影像維度超出範圍。請參閱文件中支援的影像維度。
InvalidRequest	InvalidContentLength	輸入影像太大。請參閱文件中的檔案大小上限。
InvalidRequest	InvalidFieldsDefinition	無效的欄位：{details}
InvalidRequest	InvalidTrainingContentLength	定型內容包含 {bytes} 個位元組。定型受限於 {maxBytes} 個位元組。
InvalidRequest	InvalidTrainingContentPageCount	定型內容包含 {pages} 頁。定型受限於 {pages} 頁。
InvalidRequest	ModelAnalyzeError	無法使用自訂模型進行分析：{details}
InvalidRequest	ModelBuildError	無法建置模型：{details}
InvalidRequest	ModelComposeError	無法構成模型：{details}
InvalidRequest	ModelNotReady	模型尚未準備好用於要求的作業。等候定型完成或檢查作業錯誤。
InvalidRequest	ModelReadOnly	要求的模型是唯讀的。
InvalidRequest	NotSupportedApiVersion	要求的作業需要 {minimumApiVersion} 或更新版本。
InvalidRequest	OperationNotCancellable	已經無法取消此作業。
InvalidRequest	TrainingContentMissing	遺漏定型資料：{details}
InvalidRequest	UnsupportedContent	無法支援內容：{details}
NotFound	ModelNotFound	找不到要求的模型。模型已刪除或仍在建置中。
NotFound	OperationNotFound	找不到要求的作業。識別碼無效，或作業已過期。

共用方式為

錯誤指南 v4.0、v3.1 和 v3.0

意見反應

其他資源