更新时间:2021-12-31 GMT+08:00
分享

查询追踪器

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/trackers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

tracker_name

String

标示追踪器名称。 在不传入该字段的情况下,将查询租户所有的追踪器。

tracker_type

String

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

枚举值:

  • system

  • data

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

trackers

Array of TrackerResponseBody objects

本次查询追踪器列表返回的追踪器数组。

表4 TrackerResponseBody

参数

参数类型

描述

id

String

追踪器唯一标识。

create_time

Long

追踪器创建时间戳。

kms_id

String

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

is_support_validate

Boolean

是否打开事件文件校验。

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"时有效。

表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

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

is_authorized_bucket

Boolean

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

bucket_lifecycle

Long

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

表7 DataBucketQuery

参数

参数类型

描述

data_bucket_name

String

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

search_enabled

Boolean

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

data_event

Array of strings

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

  • 当启用或者停用数据类追踪器时,该参数为必选。

  • 管理类追踪器无此参数。

  • 追踪器一旦创建追踪桶无法修改。

枚举值:

  • WRITE

  • READ

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码标识,CTS.XXX。

error_msg

String

错误描述。

请求示例

GET https://{endpoint}/v3/{project_id}/trackers?tracker_name=system

响应示例

状态码: 200

请求成功。

{
  "trackers" : [ {
    "is_support_trace_files_encryption" : true,
    "create_time" : 1589886034121,
    "streamId" : "4a1ef2b6-d79a-4dc6-90f0-48151cd5491b",
    "kms_id" : "7dbbb3fa-93e4-4528-bc7b-9beb794b0229",
    "groupId" : "26fa12ac-75f7-42ed-8118-ab9f2263042f",
    "is_support_validate" : false,
    "obs_info" : {
      "is_obs_created" : false,
      "bucket_name" : "",
      "is_authorized_bucket" : false,
      "file_prefix_name" : "",
      "bucket_lifecycle" : 0
    },
    "lts" : {
      "log_group_name" : "CTS",
      "is_lts_enabled" : true,
      "log_topic_name" : "system-trace"
    },
    "tracker_type" : "system",
    "domain_id" : "2306579dc99f4c8690b14b68e734fcd9",
    "project_id" : "24edf66e79d04187acb99a463e610764",
    "tracker_name" : "system",
    "id" : "ebf8d1c3-762b-4ce3-b316-6b1aa32f8be3",
    "status" : "enabled"
  }, {
    "domain_id" : "2306579dc99f4c8690b14b68e734fcd9",
    "is_support_trace_files_encryption" : false,
    "obs_info" : {
      "is_obs_created" : false,
      "bucket_name" : "",
      "is_authorized_bucket" : false,
      "file_prefix_name" : "",
      "bucket_lifecycle" : 0
    },
    "create_time" : 1589276171198,
    "project_id" : "24edf66e79d04187acb99a463e610764",
    "data_bucket" : {
      "data_event" : [ "READ", "WRITE" ],
      "search_enabled" : false,
      "data_bucket_name" : "cstest0423"
    },
    "tracker_name" : "sdsa",
    "is_support_validate" : false,
    "lts" : {
      "log_group_name" : "CTS",
      "is_lts_enabled" : false,
      "log_topic_name" : "sdsa"
    },
    "id" : "c9a3961d-3aa0-4e60-8e63-dd4ce7f1a88a",
    "status" : "enabled",
    "tracker_type" : "data"
  } ]
}

状态码

状态码

描述

200

请求成功。

400

服务器未能处理请求。

401

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

403

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

500

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

503

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

错误码

请参见错误码

分享:

    相关文档

    相关产品

close