审计日志
更新时间:2026-08-27
云数据库 DocDB for MongoDB 支持通过 OpenAPI 开启、关闭和查询审计日志。
开启审计日志服务
| 字段名 | 含义 | 类型 | 是否必填 | 注意事项 |
|---|---|---|---|---|
| instanceId | 实例 ID | String | 是 | 框架会用该值覆盖请求体中的 dbInstanceId |
Query Parameters:
| 字段名 | 含义 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| type | 日志类型:running=运行日志、error=错误日志、slow=慢日志、audit=审计日志 | String | running | 否 |
Body Parameters:
| 字段名 | 含义 | 类型 | 是否必填 | 注意事项 |
|---|---|---|---|---|
| .type | 日志类型(如 running/audit 等) | String | 否 | 与 query 中 type 含义一致 |
请求示例:
JavaScript
1PUT /v1/instance/m-CH2TVe?startLogging&type=audit
2
3{
4 "type": "audit"
5}
响应:无返回体(HTTP 200 表示成功)。
关闭审计日志服务
Path Parameters:
| 字段名 | 含义 | 类型 | 是否必填 |
|---|---|---|---|
| instanceId | 实例 ID | String | 是 |
Query Parameters:
| 字段名 | 含义 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| type | 日志类型:running=运行日志、error=错误日志、slow=慢日志、audit=审计日志 | String | audit | 否 |
Body Parameters:
| 字段名 | 含义 | 类型 | 是否必填 |
|---|---|---|---|
| .dbInstanceId | 数据库实例 ID | String | 否 |
| .type | 日志类型 | String | 否 |
请求示例:
JavaScript
1PUT /v1/instance/m-CH2TVe?stopLogging&type=audit
2
3{
4 "type": "audit"
5}
响应:无返回体(HTTP 200 表示成功)。
查询审计日志记录
Path Parameters:
| 字段名 | 含义 | 类型 | 是否必填 |
|---|---|---|---|
| instanceId | 实例 ID | String | 是 |
Query Parameters:
| 字段名 | 含义 | 类型 | 默认值 | 是否必填 |
|---|---|---|---|---|
| startTime | 开始时间,参考值2026-08-07T07:38:07Z | String | "" | 是 |
| endTime | 结束时间 | String | "" | 是 |
| limit | 返回记录数上限 | String | BLS 默认最大值 | 否 |
| opType | 操作类型过滤(insert/update/delete/query 等) | String | "" | 否 |
| database | 数据库名称过滤 | String | "" | 否 |
| collection | 集合名称过滤 | String | "" | 否 |
| user | 用户名过滤 | String | "" | 否 |
| remoteIp | 来源 IP 过滤 | String | "" | 否 |
Response(Normal): 返回 QueryAuditLogRecordsResponse。
| 字段名 | 含义 | 类型 |
|---|---|---|
| .logs | 审计日志记录列表 | List |
| .logs[].opName | 操作名称 | String |
| .logs[].dbName | 数据库名称 | String |
| .logs[].collName | 集合名称 | String |
| .logs[].userName | 操作用户名 | String |
| .logs[].opDetail | 操作详情 | String |
| .logs[].remoteIp | 来源 IP | String |
| .logs[].opTime | 操作时间 | String |
| .columnStatistics | 列统计数据(用于前端筛选展示) | List |
评价此篇文章
