error 对象中的保留属性名

JSON 对象的 error 属性可以包含以下属性。

error.code

属性值类型：integer | 父级：error

表示此错误的代码。此属性值通常表示 HTTP 响应码。如果有多个错误，code 将是第一个错误的错误代码。 示例：

{
  "error":{
    "code": 404
  }
}

error.message

属性值类型：string | 父级：error

提供有关错误更多详细信息的人类可读消息。如果有多个错误，message 将是第一个错误的消息。 示例：

{
  "error":{
    "message": "File Not Found"
  }
}

error.errors

属性值类型：array | 父级：error

有关错误的任何附加信息的容器。如果服务返回多个错误，errors 数组中的每个元素表示一个不同的错误。 示例：

{ "error": { "errors": [] } }

error.errors[].domain

属性值类型：string | 父级：error.errors

引发此错误的服务的唯一标识符。这有助于区分特定于服务的错误（如在日历中插入事件时的错误）和通用协议错误（如文件未找到）。 示例：

{
  "error":{
    "errors": [{"domain": "Calendar"}]
  }
}

error.errors[].reason

属性值类型：string | 父级：error.errors

此错误的唯一标识符。与 error.code 属性不同，这不是 HTTP 响应码。 示例：

{
  "error":{
    "errors": [{"reason": "ResourceNotFoundException"}]
  }
}

error.errors[].message

属性值类型：string | 父级：error.errors

提供有关错误更多详细信息的人类可读消息。如果只有一个错误，此字段将与 error.message 匹配。 示例：

{
  "error":{
    "code": 404,
    "message": "File Not Found",
    "errors": [{"message": "File Not Found"}]
  }
}

error.errors[].location

属性值类型：string | 父级：error.errors

错误的位置（其值的解释取决于 locationType）。 示例：

{
  "error":{
    "errors": [{"location": ""}]
  }
}

error.errors[].locationType

属性值类型：string | 父级：error.errors

指示如何解释 location 属性。 示例：

{
  "error":{
    "errors": [{"locationType": ""}]
  }
}

error.errors[].extendedHelp

属性值类型：string | 父级：error.errors

一个 URI，指向可能对了解错误有更多帮助的帮助文本。 示例：

{
  "error":{
    "errors": [{"extendedHelper": "https://url.to.more.details.example.com/"}]
  }
}

error.errors[].sendReport

属性值类型：string | 父级：error.errors

一个 URI，指向服务用于收集错误条件数据的报告表单。此 URI 应预加载描述请求的参数。 示例：

{
  "error":{
    "errors": [{"sendReport": "https://report.example.com/"}]
  }
}