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

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

可能的話，內部錯誤屬性中會指定更多詳細數據。

最上層錯誤碼	內部錯誤碼	訊息
衝突	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	找不到要求的作業。 標識碼無效，或作業已過期。