接下来，就让小编带你一起了解如何定制API日志吧！

适用版本

该功能适用版本为苍穹V6.0.4以上。

功能速览

API日志用于记录OpenAPI调用过程中的请求参数、执行过程、响应结果、错误码等信息，便于开发与运维人员根据实时日志查询，分析接口调用结果，进行接口故障定位和日志审计等操作。

用户可以根据项目实际使用情况，配置API日志记录的详细程度，同时还可以单独记录请求出入参中的关键业务字段，方便快速定位到对应的API日志记录。

场景一：自定义API日志级别

用户（管理员）可以通过OpenAPI系统参数配置，来定义不同级别的API日志和日志保留天数。

1）配置API日志级别

路径：【基础服务云】→【公共设置】→【参数配置】→【系统参数】，在OpenAPI参数中，可以配置API日志级别：摘要日志、详细日志和大文本日志。用户可以按需勾选日志级别，并维护日志保存天数。

备注：从苍穹版本V6.0.3开始，只有管理员账号有权限在公共设置中维护OpenAPI参数。

图1 配置OpenAPI参数 - API日志级别

2）查看API调用日志

路径：【开放服务云】→【OpenAPI】→【监控统计】→【API日志】，打开API调用日志列表界面，在这里我们可以看到API日志调用记录，包含日志基本信息、请求参数、错误消息、调用状态、调用时间、调用方、API耗时、traceid等信息。

备注：日志默认保留30天，到期自动清理。

图2 查看API调用日志

图3 查看API调用详细日志

3）查看API大文本日志

若在OpenAPI参数中，配置了记录“大文本日志”，那么在调用接口（特别是批量保存或列表查询API）后，在API日志详情中，用户可以点击“导出详细日志”，系统会生成一个txt文件，展示完整的请求参数和响应结果。

图4 查看API调用大文本日志

场景二：自定义日志关键字段

用户可以通过对API进行简单配置，即可在API日志中单独记录请求出入参中的关键字段，如单据编码、创建组织等，从而快速过滤对应的日志记录，进行日志审计或问题定位。

1）配置日志记录模板

路径：【开放服务云】→【OpenAPI】→【API管理】→【API开发】，这里以供应链管理中常用的采购订单保存接口为例，首先通过零代码配置快速开发一个API，在配置项中维护入参日志记录模板和出参日志记录模板。

图5 开发API接口

这里参考示例，通过脚本维护关键字段，下面我们将采购订单编码和分录中物料编码作为入参关键字段，单据id作为出参关键字段。

图6 维护入参日志记录模板

图7 维护出参日志记录模板

2）调用接口生成日志

在维护完API基本信息、日志记录模板和请求参数后，点击“保存”按钮，就可以调用API了。

图8 维护API请求参数

点击API测试，发送请求。

图9 API测试

3）查看API调用日志

路径：【开放服务云】→【OpenAPI】→【监控统计】→【API日志】，此时我们可以看到API日志的入参摘要和出参摘要中，记录了上一步配置的关键字段，若存在多条数据通过逗号分隔。

图10 查看API调用日志 - 入参/出参摘要

API日志列表右上方支持搜索入参摘要和出参摘要。

图11 通过入参/出参摘要过滤日志

亮点价值

亮点一：精细化日志管理

通过自定义API日志级别，管理员可以根据系统运行状态和需求，有选择地记录不同级别的API日志，既满足对详细信息的追踪需求，又避免了不必要的冗余信息。

亮点二：快速问题定位

通过简单配置，能够单独记录关键业务字段，问题定位更高效，提高系统运维的效率，减少问题排查的时间。

划重点

苍穹V6.0 OpenAPI支持自定义API日志级别和日志关键字段，日志管理更精细，问题定位更高效。使用时应注意：

• 若苍穹版本高于6.0.3，API调用日志记录级别只能由管理员账号在公共设置中维护。

• 维护API日志记录模板时，需要注意请求参数和响应参数层级，否则可能无法记录到对应的数据。