全部产品
云市场

如何获取错误信息

更新时间:2017-06-07 13:26:11

所有的 API 请求只要到达了网关,网关就会返回请求结果信息。

用户需要查看返回结果的头部,即 Header 部分。其中 X-Ca开头的均为网关返回,比较重要信息是:

  1. X-Ca-Request-Id: 7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF
  2. //请求唯一ID,请求一旦进入API网关应用后,API网关就会生成请求ID并通过响应头返回给客户端,建议客户端与后端服务都记录此请求ID,可用于问题排查与跟踪
  3. X-Ca-Error-Message: Invalid Url
  4. //API网关返回的错误消息,当请求出现错误时API网关会通过响应头将错误消息返回给客户端
  5. X-Ca-Debug-Info: {"ServiceLatency":0,"TotalLatency":2}
  6. //当打开Debug模式后会返回Debug信息,此信息后期可能会有变更,仅用做联调阶段参考

在 Header 中获得 X-Ca-Error-Message 可以基本明确报错原因,而 X-Ca-Request-Id 可以用于提供给这边的支持人员,供支持人员搜索日志。