跳转到主要内容
1签 (OneSign)

Error

本页内容

业务 API 失败响应的完整格式。按 error.code 判断原因,保存 request_id 用于排查,不从 message 文本推断业务是否成功。

如何阅读本模型

先从下方相关接口确认该模型用于请求还是响应,再按字段层级读取。请求模型由调用方填写,响应模型由平台返回;同名字段在不同模型中可能含义不同。

应用、版本、任务和回执的区别见基本概念。需要一份可跟做的示例时,从相关接口进入对应产品指南。

字段定义

“必需”指字段所在的对象出现时,该字段是否必须存在。类型中含 null 表示值允许为空;未返回、null、空字符串和零分别处理。

字段必需说明
request_id 是

平台生成的请求标识。排查问题时请提供此值。

类型:string

error 是

任务失败说明或请求错误对象。为空时没有可用错误详情。

类型:object

error.code 是

机器可读的代码,用于业务判断。

类型:string

error.message 是

供人阅读的业务说明。程序分支应使用状态或错误码。

类型:string

相关接口

下面根据接口定义列出使用本模型的操作,包括嵌套在其他对象中的情况。接口示例展示完整请求和响应;模型本身不会增加任何权限。

作为错误响应

查看其余 47 个接口