更新时间:2023-11-24 GMT+08:00

设置审计日志策略

接口说明

设置审计日志策略。

约束说明

冻结实例,异常实例不支持该操作。

URI

  • URI格式

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policy

  • URI样例

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/5cecca4c20e04146862651b8d385f26ain02/auditlog-policy

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

从IAM服务获取的用户Token。请参考认证鉴权

project_id

string

path

租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。

请求消息

  • 参数说明
    表2 参数说明

    名称

    参数类型

    是否必选

    描述

    keep_days

    Integer

    审计日志保存天数,取值范围为0或7~732。

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

    reserve_auditlogs

    String

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

    • true(默认),表示关闭审计日志策略的同时,保留历史审计日志。
    • false,表示关闭审计日志策略的同时,删除已有的历史审计日志。

    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文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码

错误码

详情请参见错误码