更新时间:2021-12-31 GMT+08:00
分享

修改追踪器

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

PUT /v3/{project_id}/tracker

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,参见《云审计服务API参考》“获取账号ID和项目ID”章节。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

tracker_type

String

标识追踪器类型。 目前支持系统追踪器类型有管理类追踪器(system)和数据类追踪器(data)。 数据类追踪器和管理类追踪器共同参数有:is_lts_enabled, obs_info, is_support_validate; 管理类追踪器参数:is_support_trace_files_encryption, kms_id; 数据类追踪器参数:tracker_name, data_bucket。

枚举值:

  • system

  • data

tracker_name

String

标识追踪器名称。 当"tracker_type"参数值为"system"时该参数为默认值"system"。 当"tracker_type"参数值为"data"时该参数需要指定追踪器名称"。

status

String

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

枚举值:

  • enabled

  • disabled

is_lts_enabled

Boolean

是否打开事件分析。

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"时该参数值有效。

表3 TrackerObsInfo

参数

是否必选

参数类型

描述

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"时该参数值有效。

枚举值:

  • 30

  • 60

  • 90

  • 180

  • 1095

表4 DataBucket

参数

是否必选

参数类型

描述

data_bucket_name

String

数据类追踪器追踪对象的桶名。

  • 当启用或者停用数据类追踪器时,该参数为必选。

  • 管理类追踪器无此参数。

  • 追踪器一旦创建追踪桶无法修改。

data_event

Array of strings

数据类追踪器追踪的操作类型。

  • 当启用或者停用数据类追踪器时,该参数为必选。

  • 管理类追踪器无此参数。

枚举值:

  • WRITE

  • READ

响应参数

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识,CTS.XXX。

error_msg

String

错误描述。

请求示例

  • 管理类追踪器修改样例。

    PUT https://{endpoint}/v3/{project_id}/tracker
    
    {
      "tracker_type" : "system",
      "tracker_name" : "system",
      "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"
    }
  • 数据类追踪器修改样例。

    {
      "tracker_type" : "data",
      "tracker_name" : "data-tracker-name",
      "obs_info" : {
        "is_obs_created" : false,
        "bucket_name" : "",
        "file_prefix_name" : "",
        "bucket_lifecycle" : 60
      },
      "is_lts_enabled" : true,
      "data_bucket" : {
        "data_event" : [ "READ", "WRITE" ]
      }
    }

响应示例

状态码

状态码

描述

200

请求正常。

400

服务器未能处理请求。

401

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

403

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

404

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

500

服务内部异常,请求未完成。

503

被请求的服务无效。建议直接修改该请求,不要重试该请求。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close