查询追踪器
功能介绍
开通云审计服务成功后，您可以在追踪器信息页面查看追踪器的详细信息。详细信息主要包括追踪器名称，用于存储操作事件的OBS桶名称和OBS桶中的事件文件前缀。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/trackers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，参见获取账号ID和项目ID章节。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
tracker_name |
否 |
String |
标示追踪器名称。 在不传入该字段的情况下，将查询租户所有的追踪器。 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
trackers |
Array of TrackerResponseBody objects |
本次查询追踪器列表返回的追踪器数组。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
追踪器唯一标识。 |
|
create_time |
Long |
追踪器创建时间戳。 |
|
lts |
Lts object |
事件分析 |
|
tracker_type |
String |
标识追踪器类型。 目前支持系统追踪器类型有管理类追踪器（system）。 枚举值：
|
|
domain_id |
String |
账号ID，参见《云审计服务API参考》“获取账号ID和项目ID”章节。 |
|
project_id |
String |
项目ID。 |
|
tracker_name |
String |
标识追踪器名称，当前版本默认为“system”。 |
|
status |
String |
标识追踪器状态，包括正常（enabled），停止（disabled）和异常（error）三种状态，状态为异常时需通过明细（detail）字段说明错误来源。 枚举值：
|
|
detail |
String |
该参数仅在追踪器状态异常时返回，用于标识追踪器异常的原因，包括桶策略异常（bucketPolicyError），桶不存在（noBucket）和欠费或冻结（arrears）三种原因。 |
|
obs_info |
ObsInfo object |
事件转储桶信息。 |
|
group_id |
String |
LTS服务日志组的ID。 |
|
stream_id |
String |
LTS服务日志流的ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
is_lts_enabled |
Boolean |
是否启用日志服务检索功能。 |
|
log_group_name |
String |
云审计服务在日志服务中创建的日志组名称。 |
|
log_topic_name |
String |
云审计服务在日志服务中创建的日志主题名称。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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格式。 枚举值：
|
|
is_sort_by_service |
Boolean |
路径按云服务划分，打开后转储文件路径中将增加云服务名。默认为true。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
状态码： 503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
请求示例
GET https://{endpoint}/v3/{project_id}/trackers?tracker_name=system
响应示例
状态码： 200
请求成功。
{
"trackers" : [ {
"create_time" : 1589886034121,
"stream_id" : "4a1ef2b6-d79a-4dc6-90f0-48151cd5491b",
"group_id" : "26fa12ac-75f7-42ed-8118-ab9f2263042f",
"obs_info" : {
"is_obs_created" : false,
"bucket_name" : "",
"is_authorized_bucket" : false,
"file_prefix_name" : "",
},
"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"
}
]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
服务器未能处理请求。 |
|
401 |
请求鉴权校验失败，访问被拒绝。 |
|
403 |
请求权限校验失败，访问被禁止。 |
|
500 |
服务内部异常，请求未完成。 |
|
503 |
被请求的服务无效。建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
