文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 日志管理/ 设置审计日志策略- SetAuditLogPolicy
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置审计日志策略 - SetAuditLogPolicy

功能介绍

设置审计日志策略。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:auditlog:operate

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:modify
    • gaussdb:instance:modifyTraceSQLPolicy

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/audit-log-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

内容类型。

约束限制：

不涉及。

取值范围：

application/json。

默认取值：

application/json。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

keep_days

是

Integer

参数解释：

审计日志保存天数，0表示关闭审计日志策略。

约束限制：

不涉及。

取值范围：

0~732。

默认取值：

7。

reserve_audit_logs

否

Boolean

参数解释：

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

约束限制：

不涉及。

取值范围：

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

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

默认取值：

true。

audit_types

否

Array of strings

参数解释：

审计记录的操作类型，动态范围。空表示不过滤任何操作类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

result

String

参数解释：

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

取值范围：

COMPLETED|FAILED。

job_id

String

参数解释：

任务流id。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 更新审计日志策略

    PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin07/audit-log-policy

{
  "keep_days" : 5,
  "audit_types" : [ "SELECT" ]
}

  • 关闭审计日志策略

    PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin07/audit-log-policy

{
  "keep_days" : 0,
  "reserve_audit_logs" : false
}

响应示例

状态码：200

Success.

{
  "result" : "COMPLETED",
  "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 日志管理