响应规范
业务接口统一使用 code、message、data 响应外壳。通用错误在本页集中说明,各接口详情只列出成功响应及特有错误。各状态码按实际条件返回,并非每次调用都可能触发全部错误。
成功响应
{
"code": "OK",
"message": "",
"data": {}
}普通成功使用 HTTP 200,创建资源使用 201,异步受理使用 202;无业务数据时 data 为 null。data 的具体结构见各接口说明。
异步受理的 OK 不代表任务已完成,应查询操作状态。协议调用还需检查 data.success、data.code 和具体协议结果,不能仅根据 HTTP 200 或外层 OK 判断协议业务成功。
通用错误响应
{
"code": "INVALID_INPUT",
"message": "invalid request",
"data": null
}HTTP 状态码表示错误类别,code 为稳定的业务错误码,message 为错误说明,data 为 null。上例 message 仅为示意,客户端应依据状态码与 code 处理错误。
| HTTP | code | 含义 | 处理建议 |
|---|---|---|---|
400 | INVALID_INPUT | 参数或请求体无效 | 检查参数格式、类型和请求体。 |
401 | UNAUTHORIZED | 密钥无效、过期、撤销或租户不可用 | 检查 Bearer 密钥、有效期及租户状态。 |
403 | FORBIDDEN | 协议身份与实例不匹配或操作被拒绝 | 检查实例账号、请求身份与操作权限。 |
404 | NOT_FOUND | 实例不存在、不属于当前租户或资源不存在 | 检查资源 ID、接口路径与租户归属。 |
409 | CONFLICT | 实例状态、版本或租约冲突 | 查询最新实例状态及正在执行的操作后再决定是否重试。 |
429 | RATE_LIMITED | 请求频率超过限制 | 降低调用频率,延迟后重试。 |
500 | INTERNAL_ERROR | 内部错误,不暴露内部详情 | 记录请求信息并联系服务维护者;message 固定为 internal server error。 |
消息发送超时或结果不明时,先核对实际结果,避免重试导致重复发送。协议发送不提供可靠发送队列或自动重试承诺。
具体参数与业务响应见开放接口参考。