API日志介绍

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开始，只有