錯(cuò)誤對(duì)象中的保留屬性名

錯(cuò)誤對(duì)象中的保留屬性名

JSON對(duì)象的error屬性應(yīng)包含以下屬性。

error.code

屬性值類型: 整數(shù)(integer)
父節(jié)點(diǎn): error

表示該錯(cuò)誤的編號(hào)。這個(gè)屬性通常表示HTTP響應(yīng)碼。如果存在多個(gè)錯(cuò)誤，code應(yīng)為第一個(gè)出錯(cuò)的錯(cuò)誤碼。

示例：

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

error.message

屬性值類型: 字符串(string)
父節(jié)點(diǎn): error

一個(gè)人類可讀的信息，提供有關(guān)錯(cuò)誤的詳細(xì)信息。如果存在多個(gè)錯(cuò)誤，message應(yīng)為第一個(gè)錯(cuò)誤的錯(cuò)誤信息。

示例：

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

error.errors

屬性值類型: 數(shù)組(array)
父節(jié)點(diǎn): error

包含關(guān)于錯(cuò)誤的附加信息。如果服務(wù)返回多個(gè)錯(cuò)誤。errors數(shù)組中的每個(gè)元素表示一個(gè)不同的錯(cuò)誤。

示例：

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

error.errors[].domain

屬性值類型: 字符串(string)
父節(jié)點(diǎn): error.errors

服務(wù)拋出該錯(cuò)誤的唯一識(shí)別符。它幫助區(qū)分服務(wù)的從普通協(xié)議錯(cuò)誤(如,找不到文件)中區(qū)分出具體錯(cuò)誤(例如，給日歷插入事件的錯(cuò)誤)。

示例：

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

error.errors[].reason

屬性值類型: 字符串(string)
父節(jié)點(diǎn): error.errors

該錯(cuò)誤的唯一識(shí)別符。不同于error.code屬性，它不是HTTP響應(yīng)碼。

示例：

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

error.errors[].message

屬性值類型: 字符串(string)
父節(jié)點(diǎn): error.errors

一個(gè)人類可讀的信息，提供有關(guān)錯(cuò)誤的更多細(xì)節(jié)。如果只有一個(gè)錯(cuò)誤，該字段應(yīng)該與error.message匹配。

示例：

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

error.errors[].location

屬性值類型: 字符串(string)
父節(jié)點(diǎn): error.errors

錯(cuò)誤發(fā)生的位置（根據(jù)locationType字段解釋該值）。

示例：

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

error.errors[].locationType

屬性值類型: 字符串(string)
父節(jié)點(diǎn): error.errors

標(biāo)明如何解釋location屬性。

示例：

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

error.errors[].extendedHelp

屬性值類型: 字符串(string)
父節(jié)點(diǎn): error.errors

help text的URI，使錯(cuò)誤更易于理解。

示例：（注：原示例這里有筆誤，中文版這里做了校正）

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

error.errors[].sendReport

屬性值類型: 字符串(string)
父節(jié)點(diǎn): error.errors

report form的URI，服務(wù)用它來收集錯(cuò)誤狀態(tài)的數(shù)據(jù)。該URL會(huì)預(yù)先載入描述請(qǐng)求的參數(shù)

示例：

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