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

创建追踪器

功能介绍

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

调用方法

请参见如何调用API。

URI

POST /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"。

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。

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

id

String

追踪器唯一标识。

create_time

Long

追踪器创建时间戳。

lts

Lts object

事件分析

tracker_type

String

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

枚举值：

  • system

domain_id

String

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

project_id

String

项目ID。

tracker_name

String

标识追踪器名称，当前版本默认为“system”。

status

String

标识追踪器状态，包括正常（enabled），停止（disabled）和异常（error）三种状态，状态为异常时需通过明细（detail）字段说明错误来源。

枚举值：

  • enabled
  • disabled

detail

String

该参数仅在追踪器状态异常时返回，用于标识追踪器异常的原因，包括桶策略异常（bucketPolicyError），桶不存在（noBucket）和欠费或冻结（arrears）三种原因。

obs_info

ObsInfo object

事件转储桶信息。
表5 Lts

参数

参数类型

描述

is_lts_enabled

Boolean

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

log_group_name

String

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

log_topic_name

String

云审计服务在日志服务中创建的日志主题名称。
表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

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

compress_type

String

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

枚举值：

  • gzip
  • json

is_sort_by_service

Boolean

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

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

状态码： 503

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识，CTS.XXX。

error_msg

String

错误描述。

请求示例

  • 管理类追踪器创建样例。 
    POST 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" : true,
  "is_support_trace_files_encryption" : true,
  "kms_id" : "13a4207c-7abe-4b68-8510-16b84c3b5504",
  "is_support_validate" : true
}

响应示例

状态码： 201

请求成功。

{
  "id" : "2e6fa9b8-8c6e-456d-b5d3-77be972d220b",
  "create_time" : 1587958482923,
  "domain_id" : "aexxxxxxxx4d4fb4bexxxxxxx791fbf",
  "obs_info" : {
    "is_obs_created" : false,
    "bucket_name" : "test-bucket",
    "is_authorized_bucket" : false,
    "file_prefix_name" : "11",
    "bucket_lifecycle" : 30
  },
  "project_id" : "bb1xxxxxxxxe4f498cbxxxxxxxx35634",
  "lts" : {
    "is_lts_enabled" : true,
    "log_group_name" : "CTS",
    "log_topic_name" : "system-trace"
  },
  "is_support_validate" : true,
  "tracker_name" : "system",
  "tracker_type" : "system",
  "status" : "enabled"
}

状态码

状态码

描述

201

请求成功。

400

服务器未能处理请求。

401

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

403

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

404

请求中的资源不存在，请求未完成。

500

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

503

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

错误码

请参见错误码。

父主题： 追踪器管理