data 内部包含的字段有所区分:
- SYNC(同步模式):提交任务后直接返回业务数据,业务结果位于
data.result。 - ASYNC(异步模式):提交任务后先返回任务标识
data.taskId;最终业务结果需要通过 异步任务查询 接口获取。
SYNC 同步模式成功响应
ASYNC 异步模式提交响应与状态字典
向统一入口提交 ASYNC 接口后,接口仅负责创建任务,返回taskId:
GET /v1/openapi/tasks/{taskId} 查询任务,其返回的 data.status 枚举如下:
有关异步调用的完整流程与代码示例,请参阅专题文档:同步与异步任务模式。
错误码
调用方应同时检查 HTTP 状态码与响应体中的业务code,不要只根据 msg 文本判断结果。
HTTP 状态与业务 code
HTTP 状态描述传输和服务处理结果;响应体中的code 描述业务调用结果。客户端需要依次校验这两层,任何一层失败都不应继续读取 data.result。
“有限重试”是推荐的客户端恢复策略,不代表平台承诺固定的重试次数或等待时间。当前重试上限应由调用方结合业务容错要求设置。
推荐处理顺序
1
检查网络与 HTTP 状态
先处理连接失败、超时、空响应和非 2xx HTTP 状态。
2
检查业务 code
HTTP 请求完成后,再判断响应体中的
code 是否为 200。3
记录 requestId
在成功响应中记录
data.requestId;发生异常时同时保留请求时间和 apiCode。4
按错误类型恢复
参数和凭证问题应修正后再请求;限流和平台异常可采用有限次数重试。
调用限制
查看超时、并发、有限重试和指数退避建议。
requestId 请求追踪
建立生产环境排错记录。
联调排错清单
按请求、认证、权限和响应解析逐项定位问题。