云审计服务 CTS-创建追踪器:响应参数

时间:2023-12-22 17:31:29

响应参数

状态码: 201

表6 响应Body参数

参数

参数类型

描述

id

String

追踪器唯一标识。

create_time

Long

追踪器创建时间戳。

kms_id

String

事件文件转储加密所采用的秘钥id(从KMS获取)。当"tracker_type"参数值为"system"和"is_support_trace_files_encryption"参数值为“是”时,此参数为必选项。

is_support_validate

Boolean

是否打开事件文件校验。

is_organization_tracker

Boolean

是否应用到我的组织。 只针对管理类追踪器。设置为true时,ORG组织下所有成员当前区域的审计日志会转储到该追踪器配置的OBS桶或者LTS日志流,但是事件列表界面不支持查看其它组织成员的审计日志。

management_event_selector

ManagementEventSelector object

管理类事件选择器。

lts

Lts object

事件分析

tracker_type

String

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

枚举值:

  • system
  • data

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)三种原因。

is_support_trace_files_encryption

Boolean

事件文件转储加密功能开关。 该参数必须与kms_id参数同时使用。 当前环境仅"tracker_type"参数值为"system"时支持该功能。

obs_info

ObsInfo object

事件转储桶信息。

data_bucket

DataBucketQuery object

数据类事件追踪桶信息。 当"tracker_type"参数值为"data"时有效。

表7 ManagementEventSelector

参数

参数类型

描述

exclude_service

Array of strings

标识不转储的云服务名称。 目前只支持设置为KMS,表示屏蔽KMS服务的createDatakey事件。

表8 Lts

参数

参数类型

描述

is_lts_enabled

Boolean

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

log_group_name

String

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

log_topic_name

String

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

表9 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

Long

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

compress_type

String

压缩类型。包括不压缩(json),压缩(gzip)两种状态。默认为gzip格式。

枚举值:

  • gzip
  • json

is_sort_by_service

Boolean

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

表10 DataBucketQuery

参数

参数类型

描述

data_bucket_name

String

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

search_enabled

Boolean

追踪桶日志是否支持搜索。

data_event

Array of strings

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

  • 当启用或者停用数据类追踪器时,该参数为必选。
  • 管理类追踪器无此参数。
  • 追踪器一旦创建追踪桶无法修改。
  • READ OBS对象读取操作;WRITE OBS对象写操作。

枚举值:

  • WRITE
  • READ

状态码: 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识,CTS.XXX。

error_msg

String

错误描述。

状态码: 401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识,CTS.XXX。

error_msg

String

错误描述。

状态码: 403

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识,CTS.XXX。

error_msg

String

错误描述。

状态码: 404

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识,CTS.XXX。

error_msg

String

错误描述。

状态码: 500

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识,CTS.XXX。

error_msg

String

错误描述。

状态码: 503

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识,CTS.XXX。

error_msg

String

错误描述。

support.huaweicloud.com/api-cts/cts_api_0321.html