Audit Log Settings
什么是审计日志?
审计日志是一项记录API活动的功能,以支持监控、可追溯性和合规审计。它可以根据配置捕获请求的详细信息,例如 headers 和 body,通常专注于变更方法(POST/PUT/PATCH/DELETE),并仅在需要时记录GET。并且有效负载大小可能为 limited 以防止过度存储使用。
User permission:
此功能仅允许具有global-administrator角色的用户使用。
审计日志设置
-
从左侧菜单中选择 APIM Management > Setting:

-
在设置选项卡中:

① Enable Audit Log: 开启/关闭系统的审计日志记录。当启用时,API活动将根据以下设置进行记录。
② Content Log (Request header/ Request body): 选择要存储在审计日志中的请求部分(头部和/或主体)。请谨慎使用,以避免存储敏感数据并减少存储使用。
③ Resource Types: 选择哪些资源模块/功能(例如,API、策略、部署、Webhook等)应在审计日志中记录其操作。
④ Request Types: 选择要记录的HTTP方法(GET/POST/PUT/PATCH/DELETE)。通常,变更方法会被记录;GET仅在需要时启用。
⑤ Retention Period: 定义审计记录在实时数据库中保留的时间,包括:
- 周期:在实时数据库中保留日志的时间单位数量
- 单位:值的单位(例如,月)
⑥ After Retention Period:
用户可以在保留期后选择操作:
- 删除:
+) 执行时间:用户可以按照 Cron 语法格式填写
+) 立即删除:立即运行当前过期的日志。
- 存档 (S3):

+) S3 存储桶 URL:输入用于存档日志的 S3 存储桶路径(例如:s3://apim-audit-logs-archive)
+) 执行时间:用户可以按照 Cron 语法格式填写。
然后点击 Archive Now.
- 存档 (本地)
用户可以在执行时间字段中按照 Cron 语法格式填写,然后点击 Archive Now.
- 保存
在用户填写所有字段以创建审计日志后,请向上滚动并点击 Save 按钮以完成。

查看审计日志列表
成功设置审计日志后,用户可以查看如下的审计日志列表:

① 搜索功能:用户可以使用搜索功能快速找到特定的审计日志:
- 日期范围:允许用户选择开始和结束日期以过滤日志。
- 项目: 按项目过滤。
- 资源类型:按资源类型过滤。
- 方法:按请求方法(GET、POST、PUT、PATCH、DELETE)过滤。
- 用户名:通过输入用户名过滤日志。
② 表格包含以下详细信息:
- 项目(链接):项目名称作为指向项目详细信息页面的超链接。
- 资源类型:显示每个日志条目的资源类型。
- 方法:以彩色徽章显示请求方法(GET、POST、PUT、PATCH、DELETE)。
- 端点:显示相对 API 路径。
- 描述:对端点目的的简短说明。
- 时间戳:日期/时间格式为:YYYY-MM-DD HH:mm:ss。
- 用户名:显示用户名。
- 查看详情图标:查看日志详情的图标;点击后导航到日志详情屏幕。
③ 用户可以将审计日志列表导出为 CSV 或 JSON 文件:

查看审计日志详情
用户可以导航到 Audit Logs 列表页面,并点击每条记录的查看详情图标,以在弹出窗口中打开日志详情页面:
