错误指南 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 属性下会列出各个错误。 在这种情况下，每个错误的 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 属性可以是以下错误代码消息之一：

在可能的情况下，内部错误属性中会指定更多详细信息。