文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 获取日志信息/ 设置审计日志策略 - SetAuditlogPolicy
更新时间：2026-03-09 GMT+08:00
查看PDF
分享

设置审计日志策略 - SetAuditlogPolicy

功能介绍

设置审计日志策略。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:auditlog:operate

permission_management

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

接口约束

该接口仅支持MySQL和PostgreSQL数据库引擎。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/auditlog-policy

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

    获取方法请参见获取项目ID。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

    默认取值：

    不涉及。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

keep_days

是

Integer

参数解释：

审计日志保存天数。

约束限制：

不涉及。

取值范围：

  • 取值0，表示关闭审计日志策略。
  • 取值1~3660，表示开启审计日志策略，并设置审计日志保存天数为该值。

默认取值：

不涉及。

reserve_auditlogs

否

Boolean

参数解释：

关闭审计日志策略时是否保留历史审计日志。

约束限制：

该参数仅关闭审计日志策略时有效。

取值范围：

  • true：表示关闭审计日志策略的同时，保留历史审计日志。
  • false：表示关闭审计日志策略的同时，删除已有的历史审计日志。

默认取值：

true

audit_types

否

Array of strings

参数解释：

审计记录的操作类型。

约束限制：

  • 该参数仅打开审计日志策略时有效。
  • 该参数仅针对RDS for MySQL实例。

取值范围：

  • 参数值为空时，表示不过滤任何操作类型。
  • 支持记录以下具体操作类型：
    • DCL操作类型的权限：CREATE_USER,DROP_USER,RENAME_USER,GRANT,REVOKE,ALTER_USER,ALTER_USER_DEFAULT_ROLE
    • DDL操作类型的权限：CREATE,ALTER,DROP,RENAME,TRUNCATE,REPAIR,OPTIMIZE
    • DML操作类型的权限：INSERT,DELETE,UPDATE,REPLACE,SELECT
    • 其他操作类型的权限：BEGIN/COMMIT/ROLLBACK,PREPARED_STATEMENT,CALL_PROCEDURE,KILL,SET_OPTION,CHANGE_DB,UNINSTALL_PLUGIN,UNINSTALL_PLUGIN,INSTALL_PLUGIN,SHUTDOWN,SLAVE_START,SLAVE_STOP,LOCK_TABLES,UNLOCK_TABLES,FLUSH,XA

默认取值：

参数值为空时，表示不过滤任何操作类型。

请求示例

  • 设置审计日志保存5天。 
    PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog-policy
{
    "keep_days":5,
    "audit_types": [
    "CREATE_USER"
    ]
}
  • 关闭审计日志策略，同时删除已有的历史审计日志。 
    {
    "keep_days":0,
    "reserve_auditlogs":false
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    status

    String

    参数解释：

    设置审计日志策略的操作结果。

    取值范围：

    COMPLETED：执行成功。
  • 正常响应样例 
    {
  "status":"COMPLETED"
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 获取日志信息

相关文档