文档首页/ 云审计服务 CTS/ API参考/ 历史API/ 追踪器管理/ 创建追踪器
更新时间：2024-05-21 GMT+08:00
查看PDF
分享

创建追踪器

功能介绍

云审计服务开通后系统会自动创建一个追踪器，用来关联系统记录的所有操作。目前，一个云账户在一个Region下仅支持创建一个管理类追踪器。 云审计服务支持在管理控制台查询近7天内的操作记录。如需保存更长时间的操作记录，您可以在创建追踪器之后通过对象存储服务（Object Storage Service，以下简称OBS）将操作记录实时保存至OBS桶中。

URI

POST /v1.0/{project_id}/tracker

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见获取项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bucket_name

是

String

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

file_prefix_name

否

String

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

is_obs_created

否

Boolean

是否支持新建OBS桶,默认为“false”。 值为“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

是否打开事件文件校验。

响应参数

状态码： 201

表5 响应Body参数

参数

参数类型

描述

id

String

追踪器唯一标识。

create_time

Long

追踪器创建时间戳。

domain_id

String

账号ID，获取方式请参见获取账号ID。

project_id

String

项目ID。

is_support_trace_files_encryption

Boolean

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

kms_id

String

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

obs_info

ObsInfo object

转储桶信息。

status

String

标识追踪器状态，该接口返回正常状态（enabled）。

tracker_name

String

追踪器名称。

tracker_type

String

追踪器类型。

group_id

String

日志组唯一标识。

stream_id

String

日志流唯一标识。

lts

Lts object

事件分析

is_support_validate

Boolean

是否打开事件文件校验。当前环境仅"tracker_type"参数值为"system"时支持该功能。
表6 ObsInfo

参数

参数类型

描述

bucket_name

String

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

file_prefix_name

String

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

is_obs_created

Boolean

标识配置桶是否由追踪器自动创建。

is_authorized_bucket

Boolean

标识配置桶是否已经授权给CTS服务账号。

bucket_lifecycle

String

标识配置桶内对象存储周期。 当"tracker_type"参数值为"data"时该参数值有效。
表7 Lts

参数

参数类型

描述

is_lts_enabled

Boolean

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

log_group_name

String

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

log_topic_name

String

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

请求示例

POST https://{endpoint}/v1.0/{project_id}/tracker

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

响应示例

状态码： 201

请求成功。

{
  "id" : "2e6fa9b8-8c6e-456d-b5d3-77be972d220b",
  "create_time" : 1587958482923,
  "domain_id" : "aexxxxxxxx4d4fb4bexxxxxxx791fbf",
  "is_support_trace_files_encryption" : true,
  "kms_id" : "13a4207c-7abe-4b68-8510-16b84c3b5504",
  "obs_info" : {
    "bucket_name" : "obs-f1da",
    "file_prefix_name" : "yO8Q"
  },
  "project_id" : "bb1xxxxxxxxe4f498cbxxxxxxxx35634",
  "lts" : {
    "is_lts_enabled" : true,
    "log_group_name" : "CTS",
    "log_topic_name" : "system-trace"
  },
  "log_file_validate" : {
    "is_support_validate" : true
  },
  "tracker_name" : "system",
  "tracker_type" : "system",
  "status" : "enabled"
}

状态码

状态码

描述

201

请求成功。

400

服务器未能处理请求。

401

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

403

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

404

请求中的OBS桶不存在，请求未完成。

500

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

错误码

请参见错误码。

父主题： 追踪器管理