华为云用户手册

请求示例 POST https://{endpoint}/v1.0/{project_id}/tracker { "bucket_name": "obs-f1da", "is_support_trace_files_encryption": true, "kms_id": "13a4207c-7abe-4b68-8510-16b84c3b5504", "is_obs_created": true, "file_prefix_name": "yO8Q", "lts": { "is_lts_enabled": true, "log_group_name": " CTS ", "log_topic_name": 'system-trace' }, "log_file_validate": { "is_support_validate": true } }

响应示例 状态码： 201 请求成功。 { "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", "obs_info" : { "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" }

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 id String 追踪器唯一标识。 create_time Long 追踪器创建时间戳。 domain_id String 账号ID，获取方式请参见获取账号ID。 project_id String 项目ID。 is_support_trace_files_encryption Boolean 事件文件转储加密功能开关。 该参数必须与kms_id参数同时使用。 kms_id String 事件文件转储加密所采用的密钥id（从KMS获取）。 当"is_support_trace_files_encryption"参数值为“是”时，此参数为必选项。 obs_info ObsInfo object 转储桶信息。 status String 标识追踪器状态，该接口返回正常状态（enabled）。 tracker_name String 追踪器名称。 tracker_type String 追踪器类型。 group_id String 日志组唯一标识。 stream_id String 日志流唯一标识。 lts Lts object 事件分析 is_support_validate Boolean 是否打开事件文件校验。当前环境仅"tracker_type"参数值为"system"时支持该功能。 表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 String 标识配置桶内对象存储周期。 当"tracker_type"参数值为"data"时该参数值有效。 表7 Lts 参数 参数类型 描述 is_lts_enabled Boolean 是否启用日志服务检索功能。 log_group_name String 云审计 服务在日志服务中创建的日志组名称。 log_topic_name String 云审计服务在日志服务中创建的日志主题名称。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 bucket_name 是 String 标识OBS桶名称。由数字或字母开头，支持小写字母、数字、“-”、“.”，长度为3～63个字符。 file_prefix_name 否 String 标识需要存储于OBS的日志文件前缀，0-9，a-z，A-Z，'-'，'.'，'_'长度为0～64字符。 is_obs_created 否 Boolean 是否支持新建OBS桶,默认为“false”。 值为“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"参数值为“是”时，此参数为必选项。 lts 否 Lts object 事件分析 log_file_validate 否 LogFileValidate object 文件校验 表3 Lts 参数 是否必选 参数类型 描述 is_lts_enabled 是 Boolean 是否启用日志服务检索功能。 log_group_name 是 String 云审计服务在日志服务中创建的日志组名称。 log_topic_name 是 String 云审计服务在日志服务中创建的日志主题名称。 表4 LogFileValidate 参数 是否必选 参数类型 描述 is_support_validate 是 Boolean 是否打开事件文件校验。

Go 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 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("cn-north-4")). WithCredential(auth). Build()) request := &model.ListUserResourcesRequest{} response, err := client.ListUserResources(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 users Array of UserResource objects 最近30天操作事件的用户列表。 表3 UserResource 参数 参数类型 描述 name String 用户名。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 503 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。

Python 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 # coding: utf-8 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(CtsRegion.value_of("cn-north-4")) \ .build() try: request = ListUserResourcesRequest() response = client.list_user_resources(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)

Java 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 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 ListUserResourcesSolution { 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("cn-north-4")) .build(); ListUserResourcesRequest request = new ListUserResourcesRequest(); try { ListUserResourcesResponse response = client.listUserResources(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()); } } }

Go 管理类追踪器修改样例。 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 48 49 50 51 52 53 54 55 56 57 58 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("cn-north-4")). WithCredential(auth). Build()) request := &model.UpdateTrackerRequest{} bucketNameObsInfo:= "test-data-tracker" filePrefixNameObsInfo:= "11" isObsCreatedObsInfo:= false obsInfobody := &model.TrackerObsInfo{ BucketName: &bucketNameObsInfo, FilePrefixName: &filePrefixNameObsInfo, IsObsCreated: &isObsCreatedObsInfo, } isSupportValidateUpdateTrackerRequestBody:= false kmsIdUpdateTrackerRequestBody:= "" isSupportTraceFilesEncryptionUpdateTrackerRequestBody:= false isLtsEnabledUpdateTrackerRequestBody:= false statusUpdateTrackerRequestBody:= model.GetUpdateTrackerRequestBodyStatusEnum().ENABLED request.Body = &model.UpdateTrackerRequestBody{ IsSupportValidate: &isSupportValidateUpdateTrackerRequestBody, KmsId: &kmsIdUpdateTrackerRequestBody, IsSupportTraceFilesEncryption: &isSupportTraceFilesEncryptionUpdateTrackerRequestBody, ObsInfo: obsInfobody, IsLtsEnabled: &isLtsEnabledUpdateTrackerRequestBody, Status: &statusUpdateTrackerRequestBody, TrackerName: "system", TrackerType: model.GetUpdateTrackerRequestBodyTrackerTypeEnum().SYSTEM, } response, err := client.UpdateTracker(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } 数据类追踪器修改样例。 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 48 49 50 51 52 53 54 55 56 57 58 59 60 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("cn-north-4")). WithCredential(auth). Build()) request := &model.UpdateTrackerRequest{} var listDataEventDataBucket = []model.DataBucketDataEvent{ model.GetDataBucketDataEventEnum().READ, model.GetDataBucketDataEventEnum().WRITE, } dataBucketbody := &model.DataBucket{ DataEvent: &listDataEventDataBucket, } bucketNameObsInfo:= "" filePrefixNameObsInfo:= "" isObsCreatedObsInfo:= false bucketLifecycleObsInfo:= int32(60) obsInfobody := &model.TrackerObsInfo{ BucketName: &bucketNameObsInfo, FilePrefixName: &filePrefixNameObsInfo, IsObsCreated: &isObsCreatedObsInfo, BucketLifecycle: &bucketLifecycleObsInfo, } isLtsEnabledUpdateTrackerRequestBody:= true request.Body = &model.UpdateTrackerRequestBody{ DataBucket: dataBucketbody, ObsInfo: obsInfobody, IsLtsEnabled: &isLtsEnabledUpdateTrackerRequestBody, TrackerName: "data-tracker-name", TrackerType: model.GetUpdateTrackerRequestBodyTrackerTypeEnum().DATA, } response, err := client.UpdateTracker(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }

响应参数 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。

请求示例 管理类追踪器修改样例。 PUT https://{endpoint}/v3/{project_id}/tracker { "tracker_type" : "system", "tracker_name" : "system", "obs_info" : { "is_obs_created" : false, "bucket_name" : "test-data-tracker", "file_prefix_name" : "11" }, "is_lts_enabled" : false, "is_support_trace_files_encryption" : false, "kms_id" : "", "is_support_validate" : false, "status" : "enabled" } 数据类追踪器修改样例。 { "tracker_type" : "data", "tracker_name" : "data-tracker-name", "obs_info" : { "is_obs_created" : false, "bucket_name" : "", "file_prefix_name" : "", "bucket_lifecycle" : 60 }, "is_lts_enabled" : true, "data_bucket" : { "data_event" : [ "READ", "WRITE" ] } }

Python 管理类追踪器修改样例。 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 # coding: utf-8 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(CtsRegion.value_of("cn-north-4")) \ .build() try: request = UpdateTrackerRequest() obsInfobody = TrackerObsInfo( bucket_name="test-data-tracker", file_prefix_name="11", is_obs_created=False ) request.body = UpdateTrackerRequestBody( is_support_validate=False, kms_id="", is_support_trace_files_encryption=False, obs_info=obsInfobody, is_lts_enabled=False, status="enabled", tracker_name="system", tracker_type="system" ) response = client.update_tracker(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 40 41 42 43 44 45 46 47 48 49 # coding: utf-8 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(CtsRegion.value_of("cn-north-4")) \ .build() try: request = UpdateTrackerRequest() listDataEventDataBucket = [ "READ", "WRITE" ] dataBucketbody = DataBucket( data_event=listDataEventDataBucket ) obsInfobody = TrackerObsInfo( bucket_name="", file_prefix_name="", is_obs_created=False, bucket_lifecycle=60 ) request.body = UpdateTrackerRequestBody( data_bucket=dataBucketbody, obs_info=obsInfobody, is_lts_enabled=True, tracker_name="data-tracker-name", tracker_type="data" ) response = client.update_tracker(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 tracker_type 是 String 标识追踪器类型。 目前支持系统追踪器类型有管理类追踪器(system)和数据类追踪器(data)。 数据类追踪器和管理类追踪器共同参数有：is_lts_enabled, obs_info, is_support_validate; 管理类追踪器参数：is_support_trace_files_encryption, kms_id; 数据类追踪器参数：tracker_name, data_bucket。 枚举值： system data tracker_name 是 String 标识追踪器名称。 当"tracker_type"参数值为"system"时该参数为默认值"system"。 当"tracker_type"参数值为"data"时该参数需要指定追踪器名称"。 status 否 String 标识追踪器状态，该接口中可修改的状态包括正常（enabled）和停止（disabled）。如果选择修改状态为停止，则修改成功后追踪器停止记录事件。 枚举值： enabled disabled is_lts_enabled 否 Boolean 是否打开事件分析。 is_organization_tracker 否 Boolean 是否应用到我的组织。 只针对管理类追踪器。设置为true时，ORG组织下所有成员当前区域的审计日志会转储到该追踪器配置的OBS桶或者LTS日志流，但是事件列表界面不支持查看其它组织成员的审计日志。 management_event_selector 否 ManagementEventSelector object 管理类事件选择器。 obs_info 否 TrackerObsInfo object 转储桶配置 is_support_trace_files_encryption 否 Boolean 事件文件转储加密功能开关。 当"tracker_type"参数值为"system"时该参数值有效。 该参数必须与kms_id参数同时使用。 kms_id 否 String 事件文件转储加密所采用的秘钥id（从KMS获取）。 当"tracker_type"参数值为"system"时该参数值有效。 当"is_support_trace_files_encryption"参数值为“是”时，此参数为必选项。 is_support_validate 否 Boolean 事件文件转储时是否打开事件文件校验。 data_bucket 否 DataBucket object 追踪桶配置信息。 当"tracker_type"参数值为"data"时该参数值有效。 表3 ManagementEventSelector 参数 是否必选 参数类型 描述 exclude_service 否 Array of strings 标识不转储的云服务名称。 目前只支持设置为KMS，表示屏蔽KMS服务的createDatakey事件。 表4 TrackerObsInfo 参数 是否必选 参数类型 描述 bucket_name 否 String 标识OBS桶名称。由数字或字母开头，支持小写字母、数字、“-”、“.”，长度为3～63个字符。 file_prefix_name 否 String 标识需要存储于OBS的日志文件前缀，0-9，a-z，A-Z，'-'，'.'，'_'长度为0～64字符。 is_obs_created 否 Boolean 是否支持新建OBS桶。 值为“true”时，表示新创建OBS桶存储事件文件； 值为“false”时，选择已存在的OBS桶存储事件文件。 bucket_lifecycle 否 Integer 标识配置桶内对象存储周期。 当"tracker_type"参数值为"data"时该参数值有效。 枚举值： 30 60 90 180 1095 compress_type 否 String 压缩类型。包括不压缩（json），压缩（gzip）两种状态。默认为gzip格式。 枚举值： gzip json is_sort_by_service 否 Boolean 路径按云服务划分，打开后转储文件路径中将增加云服务名。默认为true。 表5 DataBucket 参数 是否必选 参数类型 描述 data_bucket_name 否 String 数据类追踪器追踪对象的桶名。 当启用或者停用数据类追踪器时，该参数为必选。 管理类追踪器无此参数。 追踪器一旦创建追踪桶无法修改。 data_event 否 Array of strings 数据类追踪器追踪的操作类型。 当启用或者停用数据类追踪器时，该参数为必选。 管理类追踪器无此参数。 READ OBS对象读取操作；WRITE OBS对象写操作。 枚举值： WRITE READ

修订记录 发布日期 修订记录 2023-9-21 第二十三次正式发布。 本次变更说明如下： 追踪器管理接口新增is_organization_tracker、management_event_selector参数说明。 2023-09-12 第二十二次正式发布。 本次变更说明如下： 新增以下接口（V3）： 查询云服务的全量操作列表 查询审计日志的操作用户列表 检查已经配置OBS桶是否可以成功转储 查询事件的资源类型列表 批量添加CTS资源标签 批量删除CTS资源标签 2023-04-20 第二十一次正式发布。 本次变更说明如下： 优化API V3“创建追踪器”的响应示例。 2021-10-15 第二十次正式发布。 本次变更说明如下： 新增以下接口（V3）： 创建关键操作通知 修改关键操作通知 查询关键操作通知 删除关键操作通知 2020-08-18 第十九次正式发布。 本次变更说明如下： “API（V1）”更名为“历史API” 新增以下章节 调用说明 终端节点 约束与限制 基本概念 API版本选择建议 2020-06-30 第十八次正式发布。 本次变更说明如下： 新增以下接口（V3）： 查询事件列表 创建追踪器 修改追踪器 查询追踪器 删除追踪器 查询租户追踪器配额信息 新增以下应用示例： 创建管理类追踪器 示例2：查询追踪器列表 示例3：查询管理类事件 2019-09-03 第十七次正式发布。 本次变更说明如下： 新增 查询事件列表(v2.0) 章节。 2019-07-24 第十六次正式发布。 本次变更说明如下： 修改 获取账号ID和项目ID 章节。 2019-01-30 第十五次正式发布。 本次变更说明如下： 修改 错误码 章节，补充错误码信息。 2018-09-30 第十四次正式发布。 本次变更说明如下： 新增 API版本号管理 章节，支持对API版本号进行查询。 2018-01-30 第十二次正式发布。 本次变更说明如下： “关键事件通知”触发条件新增“完整”场景，在创建追踪器、修改追踪器和查询追踪器章节增加相关字段。 错误码新增cts.0042~cts.0045和cts.0048。 2017-11-25 第十一次正式发布。 本次变更说明如下： 在创建追踪器、修改追踪器章节新增字段，支持事件文件完整性校验功能。 在创建追踪器、修改追踪器章节新增字段支持关键事件通知的“用户登录”功能。 2017-10-30 第十次正式发布。 本次变更说明如下： 在创建追踪器、修改追踪器章节新增字段支持通过LTS对管理类事件进行检索。 2017-09-30 第九次正式发布。 本次变更说明如下： 增加关键事件通知功能接口描述信息。 创建追踪器、修改追踪器和查询追踪器增加是否支持创建桶以及KMS的字段描述。 错误码中增加obs错误信息。 2017-08-30 第八次正式发布。 本次变更说明如下： 在查询事件列表(v1.0)中，新增“request_id”、“location_info”、“endpoint”、“resource_url”字段说明。 2017-05-26 第七次正式发布。 本次变更说明如下： 查询追踪器章节，优化关于接口响应的描述。 2017-04-28 第六次正式发布。 本次变更说明如下： 事件管理，增加查询事件列表v2.0说明。 2017-02-27 第五次正式发布。 本次变更说明如下： 查询追踪器章节，修改“200”返回值描述。 在“查询事件列表”接口中，增加“user”字段的说明。 2017-02-08 第四次正式发布。 本次变更说明如下： 修改追踪器章节，增加“400”返回值。 查询追踪器章节，增加“400”返回值。 删除追踪器章节，增加“400”返回值。 在错误码中，修改cts.0005和cts.0007错误码说明。 2017-02-03 第三次正式发布。 本次变更说明如下： 创建追踪器章节，增加“400”返回值。 修改追踪器章节，增加“bucket_name”命名规则，URI的参数说明中增加关于“tracker_name”的说明。 查询追踪器和删除追踪器章节中，URI的参数说明中增加关于“tracker_name”的说明。删除请求参数中关于“tracker name”的说明。 错误码中，修改cts.0023错误码说明。 在“查询事件列表”接口中，修改“trace_id”、“response”、“code”、“message”、“from”、“to”字段说明。增加400和404返回值说明。 2017-01-20 第二次正式发布。 本次变更说明如下： 查询事件的接口新增servicetype字段。 2016-12-30 第一次正式发布。

响应示例 状态码： 200 请求正常。 { "version" : { "id" : "v1.0", "links" : { "href" : "https://x.x.x.x/v1.0/", "rel" : "self" }, "min_version" : "", "status" : "CURRENT", "updated" : "2018-09-30T00:00:00Z", "version" : "" } }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 version Object 描述version相关对象的列表。 表3 Version 参数 参数类型 描述 id String 版本ID（版本号），如v1。 links Array of LinksBody objects API的URL地址。 version String 若该版本API支持微版本，则填支持的最大微版本号，如果不支持微版本，则填空。 status String 版本状态，为如下3种： CURRENT：表示该版本为主推版本。 SUPPORTED：表示为老版本，但是现在还继续支持。 DEPRECATED：表示为废弃版本，存在后续删除的可能。 枚举值： CURRENT SUPPORTED DEPRECATED updated String 版本发布时间，要求用UTC时间表示。如v1发布的时间2014-06-28T12:20:21Z。 min_version String 若该版本API 支持微版本，则填支持的最小微版本号， 如果不支持微版本，则填空。 表4 LinksBody 参数 参数类型 描述 href String 当前API版本的引用地址。 rel String 当前API版本和被引用地址的关系。

响应消息体（可选） 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于“获取用户Token”接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 operations Array of ListOperation objects 全量云服务的操作事件列表。 表4 ListOperation 参数 参数类型 描述 service_type String 事件对应的云服务类型。 resource_type String 事件对应的资源类型。 operation_list Array of strings 操作事件名称数组。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。

响应示例 状态码： 200 请求成功。 { "operations" : [ { "service_type" : "cts", "resource_type" : "tracker", "operation_list" : [ "updateTracker", "createTracker", "deleteTracker" ] }, { "service_type" : "cts", "resource_type" : "notification", "operation_list" : [ "updateNotification", "createNotification", "deleteNotification" ] } ] }

URI GET /v3/{project_id}/operations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，参见获取账号ID和项目ID章节。 表2 Query参数 参数 是否必选 参数类型 描述 service_type 否 String 事件对应的云服务类型。 resource_type 否 String 事件对应的资源类型。传入该参数时，service_type必选。

操作步骤 Token认证，具体操作请参考认证鉴权。 发送“POST /v1.0/{project_id}/tracker”。 在Request Header中增加“Content-Type”和“X-Auth-Token” 在Request Body中传入参数如下： POST /v1.0/{project_id}/tracker { "bucket_name": "obs-f1da", //选择转储的OBS桶名称（必填，String） "is_support_trace_files_encryption": true, //事件文件转储加密功能开关。（可选，布尔）。 "kms_id": "13a4207c-7abe-4b68-8510-16b84c3b5504", //事件文件转储加密所采用的秘钥id。( 当"is_support_trace_files_encryption"参数值为“true”时，此参数为必选项。） "is_obs_created": true, //是否支持新建OBS桶。 （可选，布尔） "file_prefix_name": "yO8Q", //标示需要存储于OBS的日志文件前缀。（可选，String） "log_file_validate": { "is_support_validate": true //是否打开事件文件校验。（可选，布尔） } } 请求响应成功后，返回已创建追踪器的信息。 { "bucket_name": "obs-f1da", "file_prefix_name": "yO8Q", "is_obs_created": true, "is_support_trace_files_encryption": true, "kms_id": "13a4207c-7abe-4b68-8510-16b84c3b5504", "log_file_validate": { "is_support_validate": true }, "tracker_name": "system", //标识追踪器名称 "status": "enabled" //标识追踪器状态。 } 若请求失败，则会返回错误码及对应的错误信息说明，详情请参考：错误码。

创建管理类追踪器 接口相关信息 URI格式：POST /v3/{project_id}/tracker 请求示例 POST https://{cts_endpoint}/v3/{project_id}/tracker {cts_endpoint}信息请从地区和终端节点获取。 Body： { "tracker_type": "system", "tracker_name": "system", "obs_info": { "is_obs_created": false, "bucket_name": "test_tracker", "file_prefix_name": " yO8Q " } } 响应示例 { "id" : "2e6fa9b8-8c6e-456d-b5d3-77be97xxxx", "create_time" : 1587958482923, "domain_id" : "aexxxxxxxx4d4fb4bexxxxxxx791fbf", "obs_info" : { "bucket_name" : " test_tracker ", "file_prefix_name" : "yO8Q" }, "project_id" : "bb1xxxxxxxxe4f498cbxxxxxxxx35634", "tracker_name" : "system", "tracker_type" : "system", "status" : "enabled" }

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在“获取用户Token”的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表1。 表1 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取帐号ID和项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 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 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme： 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint： 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如 IAM 服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path： 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string： 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在“获取用户Token”的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，同一个服务的Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 notifications Array of NotificationsResponseBody objects 关键操作通知列表。 表4 NotificationsResponseBody 参数 参数类型 描述 notification_name String 标识关键操作名称。 operation_type String 标识操作类型。 目前支持的操作类型有完整类型(complete)和自定义类型(customized)。 完整类型下，CTS发送通知的对象为已对接服务的所有事件。 自定义类型下，CTS发送通知的对象是在operations列表中指定的事件。 枚举值： customized complete operations Array of Operations objects 操作事件列表。 notify_user_list Array of NotificationUsers objects 通知用户列表，目前最多支持对10个用户组和50个用户发起的操作进行配置。 status String 标识关键操作通知状态，包括正常(enabled)，停止(disabled)两种状态。 枚举值： enabled disabled topic_id String 消息通知 服务的topic_urn或者 函数工作流 的func_urn。- 消息通知服务的topic_urn可以通过消息通知服务的查询主题列表API获取，示例：urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2。- 函数工作流的func_urn可以通过函数工作流的获取函数列表API获取，示例：urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test。 notification_id String 关键操作通知的唯一标识。 notification_type String 关键操作通知类型，根据topic_id区分为消息通知服务(smn)和函数工作流(fun)。 枚举值： smn fun project_id String 项目ID。 create_time Long 关键操作通知创建时间戳。 filter Filter object 关键操作通知高级筛选条件。 表5 Operations 参数 参数类型 描述 service_type String 标识云服务类型。必须为已对接CTS的云服务的英文缩写，且服务类型一般为大写字母。 已对接的云服务列表参见《云审计服务用户指南》“支持审计的服务及详细操作列表”章节，单击对应云服务的文档链接，可以查看到该云服务的英文缩写。 resource_type String 标识资源类型。 trace_names Array of strings 标识事件名称。 表6 NotificationUsers 参数 参数类型 描述 user_group String IAM用户组。 user_list Array of strings IAM用户。 表7 Filter 参数 参数类型 描述 condition String 多条件关系。 AND(默认值) 表示所有过滤条件满足后生效。 OR 表示有任意一个条件满足时生效。 枚举值： AND(默认值) OR is_support_filter Boolean 是否打开高级筛选开关。 rule Array of strings 高级过滤条件规则，示例如下："key != value"，格式为：字段 规则 值。-字段取值范围：api_version,code,trace_rating,trace_type,resource_id,resource_name。-规则：!= 或 =。- 值：api_version正则约束：^(a-zA-Z0-9_-.){1,64}$；code：最小长度1，最大长度256；trace_rating枚举值："normal", "warning", "incident"；trace_type枚举值："ConsoleAction", "ApiCall", "SystemAction"；resource_id：最小长度1，最大长度350；resource_name：最小长度1，最大长度256 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。 状态码： 503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码标识，CTS.XXX。 error_msg String 错误描述。

响应示例 状态码： 200 查询成功。 { "notifications" : [ { "create_time" : 1633933167385, "notify_user_list" : [ { "user_group" : "admin", "user_list" : [ "test1", "test2" ] }, { "user_group" : "CTS view", "user_list" : [ "test3", "test4" ] } ], "notification_id" : "0b98e1c2-2fd6-4e33-a355-f9e12eaab88a", "notification_name" : "test2", "notification_type" : "smn", "operation_type" : "customized", "operations" : [ { "resource_type" : "tracker", "service_type" : "CTS", "trace_names" : [ "createTracker" ] }, { "resource_type" : "notification", "service_type" : "CTS", "trace_names" : [ "deleteNotification", "updateNotification" ] }, { "resource_type" : "pe", "service_type" : " AOM ", "trace_names" : [ "createPolicyGroup", "updatePolicyGroup", "deletePolicyGroup" ] } ], "project_id" : "24edf66e79d04187acb99a463e610764", "status" : "enabled", "topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test" }, { "create_time" : 1633924057706, "notify_user_list" : [ { "user_group" : "admin", "user_list" : [ "test1", "test2" ] }, { "user_group" : "CTS view", "user_list" : [ "test3", "test4" ] } ], "notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8", "notification_name" : "test1", "notification_type" : "smn", "operation_type" : "complete", "operations" : [ ], "project_id" : "24edf66e79d04187acb99a463e610764", "status" : "disabled" } ] }

URI GET /v3/{project_id}/notifications/{notification_type} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，参见获取账号ID和项目ID章节。 notification_type 是 String 通知类型。 -smn：消息通知服务。 -fun：函数工作流。 枚举值： smn fun 表2 Query参数 参数 是否必选 参数类型 描述 notification_name 否 String 标识关键操作通知名称。 在不传入该字段的情况下，将查询当前租户所有的关键操作通知。

查询追踪器 接口相关信息 URI格式：GET /v3/{project_id}/trackers 请求示例 GET https://{cts_endpoint}/v3/{project_id}/trackers {cts_endpoint}信息请从地区和终端节点获取。 响应示例 { "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" } ] }