文档首页/ 云审计服务 CTS/ API参考 (巴黎区域)/ API V3（推荐使用）/ 追踪器管理/ 修改追踪器
更新时间：2024-06-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改追踪器

功能介绍

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

调用方法

请参见如何调用API。

URI

PUT /v3/{project_id}/tracker

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，参见获取账号ID和项目ID章节。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

tracker_type

是

String

标识追踪器类型。 目前支持系统追踪器类型有管理类追踪器(system)。

枚举值：

  • system

tracker_name

是

String

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

status

否

String

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

枚举值：

  • enabled
  • disabled

is_lts_enabled

否

Boolean

是否打开事件分析。

obs_info

否

TrackerObsInfo object

转储桶配置
表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桶存储事件文件。

compress_type

否

String

压缩类型。包括不压缩（json），压缩（gzip）两种状态。默认为gzip格式。

枚举值：

  • gzip
  • json

is_sort_by_service

否

Boolean

路径按云服务划分，打开后转储文件路径中将增加云服务名。默认为true。

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

状态码： 503

表9 响应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"
}

响应示例

无

状态码

状态码

描述

200

请求正常。

400

服务器未能处理请求。

401

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

403

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

404

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

500

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

503

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

错误码

请参见错误码。

父主题： 追踪器管理