返回结果为JSON格式。为了便于查看和美观,API 文档返回示例均有换行和缩进等处理,实际返回结果无换行和缩进处理。
1. 接口返回公共信息
接口调用不管成功还是失败都会返回的信息为:
字段名 | 字段类型 | 说明 |
---|---|---|
result | Boolean | 调用结果为成功还是失败 |
requestId | String | 请求ID |
2. 正常返回示例
接口调用成功后会返回接口调用结果、返回信息和请求ID,我们称这样的返回为正常返回。HTTP状态码为 2xx。
示例:
{
"result": true,
"requestId": "4C467B38-3910-447D-87BC-AC049166F216", /* 返回结果数据 */
"id": "X9280231-2923-SX02-KDH8-LLSKL902D8222" /*业务信息*/
}
3. 异常返回示例
接口调用出错后,会返回错误码、错误信息和请求ID,我们称这样的返回为异常返回。HTTP 状态码为 4xx 、 5xx 或者 6xx。 您可以根据接口错误码以及公共错误码 以及 API 错误中心排查错误。
示例
{
"result": false,
"requestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* 请求ID */
"code": "604", /* 错误码 */
"message": "The input parameter “CommandId” that is mandatory for processing this request is not supplied." /* 错误信息 */
}