查询日志(团队、登录、文档、后台)
适用版本>=v7.0.2504a.20250410
接口说明:查询日志(团队、登录、文档、后台)
请求说明
| 请求地址 | 配置域名+/openapi+/v7/audit_logs |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 查询企业日志信息(应用授权)kso.audit_log.read 查询和管理企业日志信息(应用授权) kso.audit_log.readwrite |
请求头(Header)
| Header | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 日志类型,可选值: group:团队, login:登录, file:文档, admin:后台 |
| operator_ids | Array | 否 | 操作用户,<= 20 items [ items [ 1 .. 20 ] characters ] |
| op_time_scope | Array | 是 | 操作时间范围. 开始时间,结束时间,= 2 items [ items [int64 ] ],时间戳,单位为秒 |
| op_keys | Array | 否 | 操作类型集合,可从“获取日志操作类型信息”接口的返回体中取值,默认是所有,[ 1 .. 100 ] items [ items [ 1 .. 1024 ] characters ]。 |
| source | string | 否 | 应用来源, 默认为所有来源,可选值:yundoc:云文档, admin:管理后台 |
| page_size | int | 是 | 分页大小,page_size和page_token值相加最大值为10000(即最多查到前10000条数据) |
| page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果 |
| group_id | string | 否 | 团队ID(仅团队类型),[ 1 .. 20 ] characters |
| file_name | string | 否 | 文件名称, 支持模糊搜索(仅文档类型),[ 1 .. 255 ] characters |
| drive_ids | Array | 否 | 文件位置, 可以是个人或团队对应的drive_id(仅文档类型)[ 1 .. 100 ] items [ items [ 1 .. 20 ] characters ] |
| success | boolean | 否 | 操作状态,不传则不过滤 。 可选值: true:成功,false:失败 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | 详细信息 |
| msg | string | 状态信息 |
| data | object | 日志列表 |
| ∟ next_page_token | string | 下一页分页标记,<= 1024 characters;当查询结果中next_page_token为空或无该返回值时,代表无下一页 |
| ∟ items | Array | Array of objects <= 1024 items |
| ∟ ∟ id | string | 日志ID |
| ∟ ∟ what | object | 操作 |
| ∟ ∟ ∟ detail | string | 操作详情 |
| ∟ ∟ ∟ file | object | 文件信息 |
| ∟ ∟ ∟ ∟file_id | string | 文件ID,<= 255 characters |
| ∟ ∟ ∟ ∟file_name | string | 文件名称,<= 255 characters |
| ∟ ∟ ∟ ∟file_path | string | 文件位置详情,<= 1024 characters |
| ∟ ∟ ∟ ∟file_pos | string | 文件位置, 取的是对drive_id的描述, 如 xxx的团队, yyy的云文档,<= 255 characters |
| ∟ ∟ ∟ ∟new_file_id | string | 新文件ID,<= 255 characters |
| ∟ ∟ ∟ group | object | 团队信息 |
| ∟ ∟ ∟ ∟ group_id | string | 团队ID,[ 1 .. 20 ] characters |
| ∟ ∟ ∟ ∟ group_name | string | 团队名称,[ 1 .. 255 ] characters |
| ∟ ∟ ∟ op_key | string | 操作类型 |
| ∟ ∟ when | object | 时间 |
| ∟ ∟ ∟ op_start_time | int | 操作开始时间,时间戳,单位为秒 |
| ∟ ∟ ∟ op_time | int | 操作结束时间,时间戳,单位为秒 |
| ∟ ∟ where | object | 地点 |
| ∟ ∟ ∟ device | object | 设备信息 |
| ∟ ∟ ∟ ∟ id | string | ID,<= 255 characters |
| ∟ ∟ ∟ ∟ platform | string | 平台类型,Enum: "ios" "web" |
| ∟ ∟ ∟ ip_addr | string | 客户端ip地址,<= 255 characters |
| ∟ ∟ ∟ source | string | 操作平台,日志来源,Enum: "yundoc" "admin" |
| ∟ ∟ who | object | 谁 |
| ∟ ∟ ∟ company_id | string | 企业ID,<= 20 characters |
| ∟ ∟ ∟ def_dept_abs_path | string | 主部门绝对路径,<= 2048 characters |
| ∟ ∟ ∟ def_dept_name | string | 主部门名称,<= 255 characters |
| ∟ ∟ ∟ operator_dept_ids | Array | 操作者所在的部门IDs,<= 100 items [ items [ 1 .. 20 ] characters ] |
| ∟ ∟ ∟ operator_id | string | 操作者ID,[ 1 .. 20 ] characters |
| ∟ ∟ ∟ operator_login_name | string | 操作者登录名,<= 255 characters |
| ∟ ∟ ∟ operator_user_name | string | 操作者姓名,<= 255 characters |
| ∟ ∟ result | object | 操作结果 |
| ∟ ∟ ∟ success | boolean | 操作成功或失败 |
响应体示例
json
{
"data": {
"items": [
{
"id": "string",
"what": {
"detail": "string",
"file": {
"file_id": "string",
"file_name": "string",
"file_path": "string",
"file_pos": "string",
"new_file_id": "string"
},
"group": {
"group_id": "string",
"group_name": "string"
},
"op_key": "string"
},
"when": {
"op_time": 0,
"op_start_time": 0
},
"where": {
"device": {
"id": "string",
"platform": "ios"
},
"ip_addr": "string",
"source": "yundoc"
},
"who": {
"company_id": "string",
"def_dept_abs_path": "string",
"def_dept_name": "string",
"operator_dept_ids": ["string"],
"operator_id": "string",
"operator_login_name": "string",
"operator_user_name": "string"
},
"result": {
"success": true
}
}
],
"next_page_token": "string"
},
"code": 0,
"detail": "string",
"msg": "string"
}