设置审计日志策略-ConfiguringSQLAudit
接口说明
设置审计日志策略。
约束说明
冻结实例，异常实例不支持该操作。
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
dds:instance:setAuditLogPolicy
permission_management
instance
dds:instance:modifyAuditLogSwitch
-
URI
|
名称 |
是否必选 |
类型 |
IN |
描述 |
|---|---|---|---|---|
|
project_id |
是 |
string |
path |
参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
instance_id |
是 |
string |
path |
参数解释： 实例ID，可以调用“查询实例列表和详情-QueryingInstancesandDetails”接口获取。如果未申请实例，可以调用“创建实例-CreatingaDBInstance”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求消息
|
名称 |
是否必选 |
类型 |
IN |
描述 |
|---|---|---|---|---|
|
X-Auth-Token |
是 |
string |
header |
参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
keep_days |
Integer |
是 |
审计日志保存天数，取值范围为0或7~732。
|
|
reserve_auditlogs |
String |
否 |
仅关闭审计日志策略时有效。
|
|
audit_scope |
String |
否 |
仅打开审计日志策略时有效，并且取值为空或者“all”时，默认全部。 审计范围。 请输入数据库或集合名称，多个库或集合请用英文逗号分隔。若名称中有英文逗号，请在逗号前添加“$”符号，用以区分分隔符。 输入长度范围不能超过1024位，且不能包含空格∧"[]{}():'和特殊字符，$符号只能在转义时使用。 |
|
audit_types |
Array of strings |
否 |
仅打开审计日志策略时有效，并且为空时，默认全部。 审计类型。支持auth，insert，delete，update，query，command等。 |
请求示例
- 打开或更新审计日志策略，保存天数为7天，审计范围为全部
{ "keep_days": 7, "audit_scope": "all", "audit_types": [ "insert" ] } - 关闭审计日志策略，删除已有的历史审计日志
{ "keep_days": 0, "reserve_auditlogs": false }
响应消息
响应示例
{}
SDK
单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
