Creating a Tracker

Function

When you enable CTS, a tracker is automatically created to associate with the cloud services you are using and record all operations on the services. A management tracker and multiple data trackers can be created by an account in a region. Traces are retained in the CTS console for seven days. For long-term storage, you can enable Object Storage Service (OBS) and deliver real-time operation records to OBS buckets.

API Calling

For details, see Calling APIs.

URI

POST /v3/{project_id}/tracker

Request Parameters

Response Parameters

Status code: 201

Status code: 400

Status code: 401

Status code: 403

Status code: 404

Status code: 500

Status code: 503

Example Request

• Creating a management tracker

  POST https://{endpoint}/v3/{project_id}/tracker
  
  {
    "tracker_type" : "system",
    "tracker_name" : "system",
    "agency_name" : "cts_admin_trust",
    "obs_info" : {
      "is_obs_created" : false,
      "bucket_name" : "test-data-tracker",
      "file_prefix_name" : "11"
    },
    "is_lts_enabled" : true,
    "is_support_trace_files_encryption" : true,
    "kms_id" : "13a4207c-7abe-4b68-8510-16b84c3b5504",
    "is_support_validate" : true
  }

• Creating a data tracker

  {
    "tracker_type" : "data",
    "tracker_name" : "data-tracker-name",
    "agency_name" : "cts_admin_trust",
    "obs_info" : {
      "is_obs_created" : false,
      "bucket_name" : "saveTraceBucket",
      "file_prefix_name" : "11",
      "bucket_lifecycle" : 30
    },
    "is_lts_enabled" : true,
    "data_bucket" : {
      "data_event" : [ "READ", "WRITE" ],
      "data_bucket_name" : "cstest0423"
    }
  }

Example Response

Status code: 201

The request is successful.

{
  "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",
  "agency_name" : "cts_admin_trust",
  "obs_info" : {
    "is_obs_created" : false,
    "bucket_name" : "test-bucket",
    "is_authorized_bucket" : false,
    "file_prefix_name" : "11",
    "bucket_lifecycle" : 30
  },
  "project_id" : "bb1xxxxxxxxe4f498cbxxxxxxxx35634",
  "lts" : {
    "is_lts_enabled" : true,
    "log_group_name" : "CTS",
    "log_topic_name" : "system-trace"
  },
  "is_support_validate" : true,
  "tracker_name" : "system",
  "tracker_type" : "system",
  "status" : "enabled"
}

Example SDK Code

The example SDK code is as follows.

Java

• Creating a management tracker

  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 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 CreateTrackerSolution { 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(); CreateTrackerRequest request = new CreateTrackerRequest(); CreateTrackerRequestBody body = new CreateTrackerRequestBody(); TrackerObsInfo obsInfobody = new TrackerObsInfo(); obsInfobody.withBucketName("test-data-tracker") .withFilePrefixName("11") .withIsObsCreated(false); body.withIsSupportValidate(true); body.withKmsId("13a4207c-7abe-4b68-8510-16b84c3b5504"); body.withIsSupportTraceFilesEncryption(true); body.withObsInfo(obsInfobody); body.withIsLtsEnabled(true); body.withTrackerName("system"); body.withTrackerType(CreateTrackerRequestBody.TrackerTypeEnum.fromValue("system")); request.withBody(body); try { CreateTrackerResponse response = client.createTracker(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()); } } }

• Creating a data tracker

  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 61 62 63 64 65

  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.*; import java.util.List; import java.util.ArrayList; public class CreateTrackerSolution { 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(); CreateTrackerRequest request = new CreateTrackerRequest(); CreateTrackerRequestBody body = new CreateTrackerRequestBody(); List<DataBucket.DataEventEnum> listDataBucketDataEvent = new ArrayList<>(); listDataBucketDataEvent.add(DataBucket.DataEventEnum.fromValue("READ")); listDataBucketDataEvent.add(DataBucket.DataEventEnum.fromValue("WRITE")); DataBucket dataBucketbody = new DataBucket(); dataBucketbody.withDataBucketName("cstest0423") .withDataEvent(listDataBucketDataEvent); TrackerObsInfo obsInfobody = new TrackerObsInfo(); obsInfobody.withBucketName("saveTraceBucket") .withFilePrefixName("11") .withIsObsCreated(false) .withBucketLifecycle(30); body.withDataBucket(dataBucketbody); body.withObsInfo(obsInfobody); body.withIsLtsEnabled(true); body.withTrackerName("data-tracker-name"); body.withTrackerType(CreateTrackerRequestBody.TrackerTypeEnum.fromValue("data")); request.withBody(body); try { CreateTrackerResponse response = client.createTracker(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()); } } }

Python

• Creating a management tracker

  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

  # 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(CtsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateTrackerRequest() obsInfobody = TrackerObsInfo( bucket_name="test-data-tracker", file_prefix_name="11", is_obs_created=False ) request.body = CreateTrackerRequestBody( is_support_validate=True, kms_id="13a4207c-7abe-4b68-8510-16b84c3b5504", is_support_trace_files_encryption=True, obs_info=obsInfobody, is_lts_enabled=True, tracker_name="system", tracker_type="system" ) response = client.create_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)

• Creating a data tracker

  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

  # 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(CtsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateTrackerRequest() listDataEventDataBucket = [ "READ", "WRITE" ] dataBucketbody = DataBucket( data_bucket_name="cstest0423", data_event=listDataEventDataBucket ) obsInfobody = TrackerObsInfo( bucket_name="saveTraceBucket", file_prefix_name="11", is_obs_created=False, bucket_lifecycle=30 ) request.body = CreateTrackerRequestBody( data_bucket=dataBucketbody, obs_info=obsInfobody, is_lts_enabled=True, tracker_name="data-tracker-name", tracker_type="data" ) response = client.create_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)

Go

• Creating a management tracker

  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

  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.CreateTrackerRequest{} bucketNameObsInfo:= "test-data-tracker" filePrefixNameObsInfo:= "11" isObsCreatedObsInfo:= false obsInfobody := &model.TrackerObsInfo{ BucketName: &bucketNameObsInfo, FilePrefixName: &filePrefixNameObsInfo, IsObsCreated: &isObsCreatedObsInfo, } isSupportValidateCreateTrackerRequestBody:= true kmsIdCreateTrackerRequestBody:= "13a4207c-7abe-4b68-8510-16b84c3b5504" isSupportTraceFilesEncryptionCreateTrackerRequestBody:= true isLtsEnabledCreateTrackerRequestBody:= true request.Body = &model.CreateTrackerRequestBody{ IsSupportValidate: &isSupportValidateCreateTrackerRequestBody, KmsId: &kmsIdCreateTrackerRequestBody, IsSupportTraceFilesEncryption: &isSupportTraceFilesEncryptionCreateTrackerRequestBody, ObsInfo: obsInfobody, IsLtsEnabled: &isLtsEnabledCreateTrackerRequestBody, TrackerName: "system", TrackerType: model.GetCreateTrackerRequestBodyTrackerTypeEnum().SYSTEM, } response, err := client.CreateTracker(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }

• Creating a data tracker

  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 61 62

  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.CreateTrackerRequest{} var listDataEventDataBucket = []model.DataBucketDataEvent{ model.GetDataBucketDataEventEnum().READ, model.GetDataBucketDataEventEnum().WRITE, } dataBucketNameDataBucket:= "cstest0423" dataBucketbody := &model.DataBucket{ DataBucketName: &dataBucketNameDataBucket, DataEvent: &listDataEventDataBucket, } bucketNameObsInfo:= "saveTraceBucket" filePrefixNameObsInfo:= "11" isObsCreatedObsInfo:= false bucketLifecycleObsInfo:= int32(30) obsInfobody := &model.TrackerObsInfo{ BucketName: &bucketNameObsInfo, FilePrefixName: &filePrefixNameObsInfo, IsObsCreated: &isObsCreatedObsInfo, BucketLifecycle: &bucketLifecycleObsInfo, } isLtsEnabledCreateTrackerRequestBody:= true request.Body = &model.CreateTrackerRequestBody{ DataBucket: dataBucketbody, ObsInfo: obsInfobody, IsLtsEnabled: &isLtsEnabledCreateTrackerRequestBody, TrackerName: "data-tracker-name", TrackerType: model.GetCreateTrackerRequestBodyTrackerTypeEnum().DATA, } response, err := client.CreateTracker(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }

More

For SDK sample code in other programming languages, see the Sample Code tab in the API Explorer.

Status Codes

Error Code

For details, see Error Codes.