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

查询追踪器

功能介绍

开通云审计服务成功后，您可以在追踪器信息页面查看系统自动创建的追踪器的详细信息。详细信息主要包括追踪器名称，用于存储操作事件的OBS桶名称和OBS桶中的事件文件前缀。

URI

GET /v1.0/{project_id}/tracker

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

tracker_name

是

String

标示追踪器名称。 在不传入该字段的情况下，将查询租户所有的追踪器。 当前版本单租户仅支持一个追踪器，名称默认为“system”。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

id

String

追踪器唯一标识。

create_time

Long

追踪器创建时间戳。

domain_id

String

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

project_id

String

项目ID。

tracker_name

String

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

tracker_type

String

标识追踪器类型。

bucket_name

String

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

file_prefix_name

String

标识需要存储于OBS的日志文件前缀。

status

String

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

枚举值：

  • enabled
  • disabled

detail

String

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

is_obs_created

Boolean

是否支持新建OBS桶。 值为“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"参数值为“是”时，此参数为必选项。

group_id

String

日志组唯一标识。

stream_id

String

日志流唯一标识。

lts

Lts object

事件分析

is_support_validate

Boolean

是否打开事件文件校验。
表4 Lts

参数

参数类型

描述

is_lts_enabled

Boolean

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

log_group_name

String

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

log_topic_name

String

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

请求示例

GET https://{endpoint}/v1.0/{project_id}/tracker?tracker_name=system

响应示例

状态码： 200

请求成功。

{
  "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",
  "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"
}

状态码

状态码

描述

200

请求成功。

400

服务器未能处理请求。

401

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

403

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

500

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

错误码

请参见错误码。

父主题： 追踪器管理

相关文档