错误消息格式

如果在处理 API 请求时出现错误,将返回一条错误消息。下表列出了错误消息的 JSON 负载中的属性。

属性

数据类型

说明

errorCode

字符串

唯一地标识出现的错误类型的字符串。用于以编程方式处理特定的错误情况。

message

字符串

出现的错误的简短说明。

details

字符串

错误的详细说明。

recommendedActions

数组<字符串>

指示特定错误情况的建议用户措施或解决方法的字符串列表。

nestedErrors

数组<错误消息>

对于多部分错误(如表单验证错误),该字段可能包含错误的各个组成部分的具体内容(例如,出现错误的各个字段)。

errorSource

字符串

对于多部分错误(如表单验证错误),该字段包含出现错误的子组成部分的标识符(例如,单个字段名称)。

data

对象

与错误关联的内部(额外)数据。外部客户通常会忽略该字段。