导出审计日志

功能介绍

日志审计，用于管理员查阅和审计用户的历史操作。功能点：

• 超级管理员/网盘管理员的日志审计功能针对企业全员范围，团队管理员仅限负责团队的日志审计。

• 日志审计包含团队所有成员在各个端（App、Web、PC、WAP）的相关操作信息，包括操作者、操作项、操作详情、客户端等信息。

• 日志可以通过PDS Web/PC客户端的管理员界面、或者调用API导出为CSV文件，下载并保存到本地。

• 日志保存180天。

API 参数说明

调用AuditLogExport - 导出审计日志，创建一个日志导出任务，API返回异步任务ID，用于查询任务进度和状态。异步任务将查询范围的日志记录生成为一个CSV文件，任务完成后返回CSV文件的下载URL。

• query：指定查询范围，支持根据空间（drive_id）、操作者（actor_id）、操作时间（acted_at）、操作类型（action_type）四种筛选方式来查询和导出日志。

• file_name：指定导出的文件名，默认为log.csv。当使用浏览器直接访问URL下载CSV文件时，该参数的值是下载到本地的文件名。

query规则

1. 支持的数据类型：

   1. 基本类型：long、string、bool、double

   2. 复合类型：array，date（时间类型，用双引号或单引号括起来，与字符串类型一致。格式"2006-01-02T00:00:00"，只支持零时区）

2. 基本类型支持的搜索：

   1. long: =, <, >, <=, >=

   2. string: = (精确搜索)

   3. bool: =

   4. double: =, <, >, <=, >=

3. 复合类型支持的搜索：

   1. array: in (多条件的=)

   2. b. date: =, <, >, <=, >=

4. 逻辑操作支持：not、and、or

5. 支持括号，优先级为：括号 > not > and > or

query举例

1、查询所有日志

query为空。

2、根据操作时间查询

acted_at > "2025-02-14T00:00:00" and acted_at < "2025-03-14T00:00:00"

3、查询特定空间的日志

通过ListDrive - 列举空间、SearchDrive - 搜索空间、ListMyDrives - 列举我的空间，查询到空间（drive）ID。查询drive ID为1、2、3的drive相关日志：

drive_id = "1" or drive_id = "2" or drive_id = "3"

数组方式查询：

drive_id in ["1", "2", "3"]

4、根据操作者查询

通过ListUser - 列举用户、SearchUser - 搜索用户，查询到用户（user）ID；再以 actor_id = user ID来查询。

（1）查询ID为user1_id的单个用户日志

actor_id = "user1_id"

（2）查询ID为user1_id或user2_id的多个用户日志

actor_id = "user1_id" or actor_id = "user2_id"

5、按照操作类型查询

（1）查询创建分享、取消分享日志

action_type="create_sl" or action_type="cancel_sl"

（2）查询上传、创建分享日志

action_type="upload_file" or action_type="create_sl"

6、组合查询

查询特定时间范围内的分享、取消分享日志

(action_type="create_sl" or action_type="cancel_sl") and acted_at > "2025-02-14T00:00:00" and acted_at < "2025-03-14T00:00:00"

日志分类

日志审计的操作类型如下：

API 调用流程

1、调用AuditLogExport - 导出审计日志，对query指定的查询范围内日志，创建导出任务，API返回导出任务的ID（async_task_id）。

请求示例：

{
    "query":"(action_type = 'upload_file') and acted_at > '2025-03-10T16:00:00' and acted_at < '2025-03-17T15:59:59'",
    "language":"zh_CN"
}

响应示例：

{
    "async_task_id":"f58c59a800d7b2cb6e1c4f7f0485b41****"
}

2、调用GetAsyncTask - 获取异步任务信息，查询日志导出任务的进度和状态。

（1）通过返回参数state判断任务状态：

• Failed（失败）

• Running（运行中）

• PartialSucceed（部分成功）

• Succeed（成功）

（2）任务执行过程中，通过返回参数consumed_process（异步任务已处理总量）、total_process（异步任务需处理总量），获取处理进度。

注意：任务初始化阶段，如果还未统计出需处理总量，total_process可能为0。

（3）任务执行成功，通过返回参数url，获取到导出文件的下载地址。地址有效期为10分钟，请及时下载。

请求示例：

{
    "async_task_id":"f58c59a800d7b2cb6e1c4f7f0485b41****"
}

任务执行中，响应示例：

{
    "async_task_id": "f58c59a800d7b2cb6e1c4f7f0485b41****",
    "state": "Running",
    "message": "task is running",
    "total_process": 4,
    "consumed_process": 0
}

任务处理成功，响应示例：

{
    "async_task_id": "f58c59a800d7b2cb6e1c4f7f0485b41****",
    "state": "Succeed",
    "total_process": 4,
    "consumed_process": 4,
    "url": "https://****"
}

使用限制

• 单次导出审计日志最多支持100万条日志记录。如果超过100万条，API会报错，信息为：HTTP code 400, errorCode: InvalidResourceUnsupported.ExportAuditLogMaxCount。遇到该错误，需要缩短查询时间区间或者添加过滤条件，重新调用导出审计日志API。