1 简介

1.1 功能介绍

• API日志用于记录OpenAPI调用过程中的请求参数、执行过程、响应结果、错误码等信息，便于开发与运维人员查询实时日志，对接口调用进行故障定位和日志审计等操作。用户可以根据实际使用情况，配置API日志记录的详细程度，详见参数配置。

• 支持单独记录请求出入参中的关键业务字段，方便快速定位API日志。同时还支持ES存储，提升查询效率。

注意：API调用日志仅记录OpenAPI日志，即URL中含kapi标识的接口，不会记录登录接口如api/login.do等的调用日志。

1.2 应用场景

• API日志监控：当系统参数中“API调用日志”的值为记录详细日志或记录摘要日志时，用户可以在该界面查看具体的调用日志。

• API日志清理：若日志量较大，建议定期清理日志。清理指南见附件金蝶云·苍穹V5.0_开放平台-日志清理配置指南-20231130.pdf。

• API日志归档：若日志需要定期归档备份留作审计，建议使用苍穹平台数据归档功能，可归档单据分别为 API调用日志（openapi_log_data）和 API调用详细日志（openapi_log_detail），归档指南详见大表冷热数据分离之数据归档。

1.3 系统路径

【开放服务云】→【OpenAPI】→【监控统计】→【API日志】

1.4 字段说明

1.5 按钮说明

2 主要操作

2.1 自定义API日志级别

管理员可以通过OpenAPI系统参数，来定义记录不同级别的API日志和日志保留天数。

1）配置API日志级别

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

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

2）查看API调用日志

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

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

3）查看API大文本日志

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

2.2 自定义日志关键字段

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

1）配置日志记录模板

路径：开放服务云 → OpenAPI → API管理 → API开发，通过零代码配置快速开发一个API，在配置项中维护入参日志记录模板和出参日志记录模板。

紧接着，通过脚本维护关键字段，例如将采购订单编码和分录中物料编码作为入参关键字段，单据id作为出参关键字段。

2）调用接口生成日志

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

点击“API测试”按钮，发送请求，生成调用记录。

3）查看API调用日志

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

3 注意事项

• 若苍穹版本高于V6.0.3，只能由管理员维护API调用日志记录级别。

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

4 更多资讯

关于OpenAPI的更多资讯，请随时关注新特性公告。