查询追踪器
功能介绍
开通云审计服务成功后,您可以在追踪器信息页面查看追踪器的详细信息。详细信息主要包括追踪器名称,用于存储操作事件的OBS桶名称和OBS桶中的事件文件前缀。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/trackers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,参见获取账号ID和项目ID章节。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
tracker_name |
否 |
String |
标示追踪器名称。 在不传入该字段的情况下,将查询租户所有的追踪器。 |
tracker_type |
否 |
String |
标识追踪器类型。 目前支持系统追踪器有管理类追踪器(system)和数据类追踪器(data)。 枚举值:
|
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
trackers |
Array of TrackerResponseBody objects |
本次查询追踪器列表返回的追踪器数组。 |
参数 |
参数类型 |
描述 |
---|---|---|
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)。 枚举值:
|
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)三种原因。 |
is_support_trace_files_encryption |
Boolean |
事件文件转储加密功能开关。 该参数必须与kms_id参数同时使用。 当前环境仅"tracker_type"参数值为"system"时支持该功能。 |
obs_info |
ObsInfo object |
事件转储桶信息。 |
data_bucket |
DataBucketQuery object |
数据类事件追踪桶信息。 当"tracker_type"参数值为"data"时有效。 |
group_id |
String |
LTS服务日志组的ID。 |
stream_id |
String |
LTS服务日志流的ID。 |
is_organization_tracker |
Boolean |
是否应用到我的组织。 只针对管理类追踪器。设置为true时,ORG组织下所有成员当前区域的审计日志会转储到该追踪器配置的OBS桶或者LTS日志流,但是事件列表界面不支持查看其它组织成员的审计日志。 |
management_event_selector |
ManagementEventSelector object |
管理类事件选择器。 |
agency_name |
String |
云服务委托名称。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
标识配置桶是否由追踪器自动创建。 |
is_authorized_bucket |
Boolean |
标识配置桶是否已经授权给CTS服务账号。 |
bucket_lifecycle |
Long |
标识配置桶内对象存储周期。 当"tracker_type"参数值为"data"时该参数值有效。 |
compress_type |
String |
压缩类型。包括不压缩(json),压缩(gzip)两种状态。默认为gzip格式。 枚举值:
|
is_sort_by_service |
Boolean |
路径按云服务划分,打开后转储文件路径中将增加云服务名。默认为true。 |
参数 |
参数类型 |
描述 |
---|---|---|
data_bucket_name |
String |
标识OBS桶名称。由数字或字母开头,支持小写字母、数字、“-”、“.”,长度为3~63个字符。 |
search_enabled |
Boolean |
追踪桶日志是否支持搜索。 |
data_event |
Array of strings |
数据类追踪器追踪对象的桶名。
枚举值:
|
参数 |
参数类型 |
描述 |
---|---|---|
exclude_service |
Array of strings |
标识不转储的云服务名称。 目前只支持设置为KMS,表示屏蔽KMS服务的createDatakey事件。 |
状态码: 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" : [ { "is_support_trace_files_encryption" : true, "create_time" : 1589886034121, "stream_id" : "4a1ef2b6-d79a-4dc6-90f0-48151cd5491b", "kms_id" : "7dbbb3fa-93e4-4528-bc7b-9beb794b0229", "group_id" : "26fa12ac-75f7-42ed-8118-ab9f2263042f", "agency_name" : "cts_admin_trust", "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" } ] }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cts.v3.region.CtsRegion; import com.huaweicloud.sdk.cts.v3.*; import com.huaweicloud.sdk.cts.v3.model.*; public class ListTrackersSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CtsClient client = CtsClient.newBuilder() .withCredential(auth) .withRegion(CtsRegion.valueOf("<YOUR REGION>")) .build(); ListTrackersRequest request = new ListTrackersRequest(); request.withTrackerName("<tracker_name>"); request.withTrackerType(ListTrackersRequest.TrackerTypeEnum.fromValue("<tracker_type>")); try { ListTrackersResponse response = client.listTrackers(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcts.v3.region.cts_region import CtsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcts.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(CtsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListTrackersRequest() request.tracker_name = "<tracker_name>" request.tracker_type = "<tracker_type>" response = client.list_trackers(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cts/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cts/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cts/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cts.NewCtsClient( cts.CtsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListTrackersRequest{} trackerNameRequest:= "<tracker_name>" request.TrackerName = &trackerNameRequest trackerTypeRequest:= model.GetListTrackersRequestTrackerTypeEnum().<TRACKER_TYPE> request.TrackerType = &trackerTypeRequest response, err := client.ListTrackers(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
服务器未能处理请求。 |
401 |
请求鉴权校验失败,访问被拒绝。 |
403 |
请求权限校验失败,访问被禁止。 |
500 |
服务内部异常,请求未完成。 |
503 |
被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。