文档中心>云 API>快速入门>使用 API Doctor(诊断能力)

使用 API Doctor(诊断能力)

最近更新时间:2024-08-22 15:44:11

我的收藏

功能介绍

诊断能力是云 API 提供的一项帮助开发者更高效地定位使用 API 过程中问题的网页版工具。用户可通过该能力轻松找出调用 API 过程中的出错点,并获取解决方案,同时可清楚的查看整个调用过程及日志等信息。

开始诊断

您可使用已获取的 RequestID、SDK 报错信息或错误码进行诊断。步骤如下:
1. 登录云 API 控制台,选择左侧导航栏中的 API Doctor(使用诊断)
2. 诊断能力中,输入完整的 RequestID、SDK 报错信息或错误码,并单击开始诊断。如下图所示:



当您使用 RequestID 或 SDK 报错信息诊断时,可获取请求链路、日志信息、错误信息、API 调试等信息。
当您使用错误码诊断时,可获取错误码描述以及对应的解决方案。

查看结果信息

诊断能力会根据您的输入请求结果,返回对应的结果信息。

成功请求结果

当您用于诊断的 RequestID 或 SDK 报错信息,其请求结果为成功时。结果会展示您的整个请求链路及日志信息,如下图所示:



失败请求结果

当您用于诊断的 RequestID 或 SDK 报错信息,其请求结果为失败时。结果会展示您的整个请求链路、错误信息、解决方案、请求日志、API 调试和文档地址及错误码信息。如下图所示:

请求链路





错误信息





解决方案



请求日志





API 调试和文档地址





错误码




当您使用错误码进行诊断时,可获取错误码描述以及对应的解决方案。如下图所示: 您可通过 云 API 平台 的错误码页面,查看产品下所有错误码的信息及进行错误码查询。