API调用日志
1. 简介
1.1 功能简介
API 调用日志,是指记录接口调用 API key 时的相关操作日志。日志中包含了调用 API Key 的接口名称、调用时间、API Key 名称、IP 地址以及返回状态等内容。
1.2 使用场景
当 API 调用失败时,可以通过 API 调用日志排查失败的具体原因,从而优化接口调用设置,提高开发效率。
1.3 预期效果
以查看全部 API 调用日志为例,效果如下所示:
2. 操作步骤
2.1 查询入口
在「密钥管理 >> API 调用日志」处,即可对API的相关调用操作进行查询。如下所示:
2.2 日志筛选
API 调用日志可根据以下条件进行筛选:
- 接口名称;
- API Key 名称;
- 调用时间。
2.3 日志信息
日志信息包含了调用 API 的接口名称、调用时间、API Key 名称、IP 地址以及返回状态等内容。设置好对应的筛选条件后,即可根据筛选条件查询对应的 API 调用日志信息。
以查询「用户应用查询接口」的API调用日志为例,效果如下所示:
2.4 返回状态
返回状态分为成功和失败两种状态。
当返回状态为失败时,在返回状态处可以同步查看失败原因。更多错误信息可参见文档:开发指南【6.2 错误码】。
注:除上述开发指南【6.2 错误码】中描述外,其他返回失败情况暂无具体失败原因。
3. 注意事项
1)API 调用日志中仅保留近 7 天的操作日志。
2)当密钥名称发生修改时,API 调用日志内历史日志中的密钥名称不会同步修改。