更新时间:2024-05-21 GMT+08:00

修改追踪器

功能介绍

云审计服务支持修改已创建追踪器的配置项,包括OBS桶转储、关键事件通知、事件转储加密、通过LTS对管理类事件进行检索、事件文件完整性校验以及追踪器启停状态等相关参数,修改追踪器对已有的操作记录没有影响。修改追踪器完成后,系统立即以新的规则开始记录操作。

URI

PUT /v1.0/{project_id}/tracker/{tracker_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

tracker_name

String

标识追踪器名称,当前版本单租户仅支持一个追踪器,名称默认为“system”。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bucket_name

String

标识OBS桶名称。由数字或字母开头,支持小写字母、数字、“-”、“.”,长度为3~63个字符。

file_prefix_name

String

标识需要存储于OBS的日志文件前缀,0-9,a-z,A-Z,'-','.','_'长度为0~64字符。

status

String

标识追踪器状态,该接口中可修改的状态包括正常(enabled)和停止(disabled)。如果选择修改状态为停止,则修改成功后追踪器停止记录事件。

枚举值:

  • enabled
  • disabled

is_obs_created

Boolean

是否支持新建OBS桶。 值为“true”时,表示新创建OBS桶存储事件文件; 值为“false”时,选择已存在的OBS桶存储事件文件。 桶名称包含数字、字母、'-'和'.'(非数字、字母类字符最多存在1个),长度为3~64字符。

is_support_trace_files_encryption

Boolean

事件文件转储加密功能开关。 该参数必须与kms_id参数同时使用。

kms_id

String

事件文件转储加密所采用的密钥id(从KMS获取)。 当"is_support_trace_files_encryption"参数值为“是”时,此参数为必选项。

lts

Lts object

事件分析

log_file_validate

LogFileValidate object

文件校验

表3 Lts

参数

是否必选

参数类型

描述

is_lts_enabled

Boolean

是否启用日志服务检索功能。

log_group_name

String

云审计服务在日志服务中创建的日志组名称。

log_topic_name

String

云审计服务在日志服务中创建的日志主题名称。

表4 LogFileValidate

参数

是否必选

参数类型

描述

is_support_validate

Boolean

是否打开事件文件校验。

响应参数

请求示例

PUT https://{endpoint}/v1.0/{project_id}/tracker/system

{ 
 "bucket_name" : "my_created_bucket", 
 "file_prefix_name" : "some_folder", 
 "is_obs_created": true,  
 "is_support_trace_files_encryption": true, 
 "kms_id": "13a4207c-7abe-4b68-8510-16b84c3b5504",
 "lts": {
   "is_lts_enabled": true,
   "log_group_name": "CTS",
   "log_topic_name": 'system-trace'
 },
 "log_file_validate": {
 "is_support_validate": true
 }, 
 "status" : "disabled"   
}

响应示例

状态码

状态码

描述

200

请求正常。

400

服务器未能处理请求。

401

请求鉴权校验失败,访问被拒绝。

403

请求权限校验失败,访问被禁止。

404

服务器无法找到被请求的资源。

500

服务内部异常,请求未完成;或部分追踪器删除失败。

错误码

请参见错误码