修改追踪器
功能介绍
云审计服务支持修改已创建追踪器的配置项,包括OBS桶转储、关键事件通知、事件转储加密、通过LTS对管理类事件进行检索、事件文件完整性校验以及追踪器启停状态等相关参数,修改追踪器对已有的操作记录没有影响。修改追踪器完成后,系统立即以新的规则开始记录操作。
调用方法
请参见如何调用API。
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| tracker_type | 是 | String | 标识追踪器类型。 目前支持系统追踪器类型有管理类追踪器(system)和数据类追踪器(data)。 数据类追踪器和管理类追踪器共同参数有:is_lts_enabled, obs_info, is_support_validate; 管理类追踪器参数:is_support_trace_files_encryption, kms_id; 数据类追踪器参数:tracker_name, data_bucket。 |
| tracker_name | 是 | String | 标识追踪器名称。 当"tracker_type"参数值为"system"时该参数为默认值"system"。 当"tracker_type"参数值为"data"时该参数需要指定追踪器名称"。 |
| status | 否 | String | 标识追踪器状态,该接口中可修改的状态包括正常(enabled)和停止(disabled)。如果选择修改状态为停止,则修改成功后追踪器停止记录事件。 |
| is_lts_enabled | 否 | Boolean | 是否开启转储到LTS。 |
| is_organization_tracker | 否 | Boolean | 是否应用到我的组织。 只针对管理类追踪器。设置为true时,ORG组织下所有成员当前区域的审计日志会转储到该追踪器配置的OBS桶或者LTS日志流,但是事件列表界面不支持查看其它组织成员的审计日志。 |
| management_event_selector | 否 | ManagementEventSelector object | 管理类事件选择器。 |
| obs_info | 否 | TrackerObsInfo object | 转储桶配置 |
| is_support_trace_files_encryption | 否 | Boolean | 事件文件转储加密功能开关。 当"tracker_type"参数值为"system"时该参数值有效。 该参数必须与kms_id参数同时使用。 |
| kms_id | 否 | String | 事件文件转储加密所采用的密钥id(从KMS获取)。 当"tracker_type"参数值为"system"时该参数值有效。 当"is_support_trace_files_encryption"参数值为“是”时,此参数为必选项。 |
| is_support_validate | 否 | Boolean | 事件文件转储时是否打开事件文件校验。 |
| data_bucket | 否 | DataBucket object | 追踪桶配置信息。 当"tracker_type"参数值为"data"时该参数值有效。 |
| agency_name | 否 | String | 云服务委托名称。 参数值为"cts_admin_trust"时,修改追踪器会自动创建云服务委托:cts_admin_trust。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| exclude_service | 否 | Array of strings | 标识不转储的云服务名称。 目前只支持设置为KMS,表示屏蔽KMS服务的createDatakey事件。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| bucket_name | 否 | String | 标识OBS桶名称。由数字或字母开头,支持小写字母、数字、“-”、“.”,长度为3~63个字符。 |
| file_prefix_name | 否 | String | 标识需要存储于OBS的日志文件前缀,0-9,a-z,A-Z,'-','.','_'长度为0~64字符。 |
| is_obs_created | 否 | Boolean | 是否支持新建OBS桶。 值为“true”时,表示新创建OBS桶存储事件文件; 值为“false”时,选择已存在的OBS桶存储事件文件。 |
| bucket_lifecycle | 否 | Integer | 标识配置桶内对象存储周期。 当"tracker_type"参数值为"data"时该参数值有效。 |
响应参数
状态码:200
请求正常。
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码标识,CTS.XXX。 |
| error_msg | String | 错误描述。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码标识,CTS.XXX。 |
| error_msg | String | 错误描述。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码标识,CTS.XXX。 |
| error_msg | String | 错误描述。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码标识,CTS.XXX。 |
| error_msg | String | 错误描述。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码标识,CTS.XXX。 |
| error_msg | String | 错误描述。 |
状态码:503
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码标识,CTS.XXX。 |
| error_msg | String | 错误描述。 |
请求示例
-
管理类追踪器修改样例。
PUT https://{endpoint}/v3/{project_id}/tracker { "tracker_type" : "system", "tracker_name" : "system", "agency_name" : "cts_admin_trust", "obs_info" : { "is_obs_created" : false, "bucket_name" : "test-data-tracker", "file_prefix_name" : "11" }, "is_lts_enabled" : false, "is_support_trace_files_encryption" : false, "kms_id" : "", "is_support_validate" : false, "status" : "enabled" } -
数据类追踪器修改样例。
PUT https://{endpoint}/v3/{project_id}/tracker { "tracker_type" : "data", "tracker_name" : "data-tracker-name", "agency_name" : "cts_admin_trust", "obs_info" : { "is_obs_created" : false, "bucket_name" : "", "file_prefix_name" : "", "bucket_lifecycle" : 60 }, "is_lts_enabled" : true, "data_bucket" : { "data_bucket_name" : "test-data-tracker", "data_event" : [ "READ", "WRITE" ] } }
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求正常。 |
| 400 | 服务器未能处理请求。 |
| 401 | 请求鉴权校验失败,访问被拒绝。 |
| 403 | 请求权限校验失败,访问被禁止。 |
| 404 | 服务器无法找到被请求的资源。 |
| 500 | 服务内部异常,请求未完成。 |
| 503 | 被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。