Updated on 2022-08-17 GMT+08:00

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.Operation records (traces) are retained for 7 days and you can check them on the CTS console. To store traces for a longer period, you can transfer them to an Object Storage Service (OBS) bucket in real time.

URI

POST /v3/{project_id}/tracker

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

tracker_type

Yes

String

Tracker type. The value can be system (management tracker) or data (data tracker). Both data and management trackers have the following parameters: is_lts_enabled, obs_info, and is_support_validate. Parameters for management trackers: is_support_trace_files_encryption and kms_id. Parameters for data trackers: tracker_name and data_bucket.

Enumeration values:

  • system

  • data

tracker_name

Yes

String

Tracker name. When tracker_type is set to system, the default value system is used. When tracker_type is set to data, you need to set this parameter to a tracker name.

is_lts_enabled

No

Boolean

Whether trace analysis is enabled.

obs_info

No

TrackerObsInfo object

Configurations of an OBS bucket to which traces will be transferred.

is_support_trace_files_encryption

No

Boolean

Whether trace files are encrypted during transfer to an OBS bucket. This parameter is valid only when tracker_type is set to system. It must be used together with kms_id.

kms_id

No

String

ID of the key used for trace file encryption. The key ID is obtained from Key Management Service (KMS). This parameter is valid only when tracker_type is set to system. This parameter is mandatory when is_support_trace_files_encryption is set to true.

is_support_validate

No

Boolean

Whether trace file verification is enabled for trace transfer.

data_bucket

No

DataBucket object

Information of an OBS bucket to be tracked. This parameter is valid when tracker_type is set to data.

Table 3 TrackerObsInfo

Parameter

Mandatory

Type

Description

bucket_name

No

String

OBS bucket name. The value contains 3 to 63 characters and must start with a number or lowercase letter. Only lowercase letters, numbers, hyphens (-), and periods (.) are allowed.

file_prefix_name

No

String

File name prefix to mark trace files that need to be stored in an OBS bucket. The value contains 0 to 64 characters. Only letters, numbers, hyphens (-), underscores (_), and periods (.) are allowed.

is_obs_created

No

Boolean

Whether a new OBS bucket is created. When the value is true, you can create an OBS bucket to store trace files. When the value is false, you can select an existing OBS bucket to store trace files.

bucket_lifecycle

No

Integer

Duration that traces are stored in the OBS bucket. This parameter is valid only when tracker_type is set to data.

Enumeration values:

  • 30

  • 60

  • 90

  • 180

  • 1095

Table 4 DataBucket

Parameter

Mandatory

Type

Description

data_bucket_name

No

String

Name of the bucket tracked by a data tracker.

  • This parameter is mandatory when you enable or disable a data tracker.

  • This parameter is unavailable for a management tracker.

  • Once a tracker is created, the bucket that it tracks cannot be changed.

data_event

No

Array of strings

Type of operations tracked by a data tracker.

  • This parameter is mandatory when you enable or disable a data tracker.

  • This parameter is unavailable for a management tracker.

Enumeration values:

  • WRITE

  • READ

Response Parameters

Status code: 201

Table 5 Response body parameters

Parameter

Type

Description

id

String

Unique tracker ID.

create_time

Long

Timestamp when the tracker was created.

kms_id

String

ID of the key used for trace file encryption. The key ID is obtained from Key Management Service (KMS).This parameter is mandatory when tracker_type is system and is_support_trace_files_encryption is true.

is_support_validate

Boolean

Whether trace file verification is enabled.

lts

Lts object

Detail about trace analysis.

tracker_type

String

Tracker type. The value can be system (management tracker) or data (data tracker).

Enumeration values:

  • system

  • data

domain_id

String

Account ID. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.

project_id

String

Project ID

tracker_name

String

Tracker name. The value is system.

status

String

Tracker status. The value can be enabled, disabled, or error. If the value is error, the detail field is required for specifying the source of the error.

Enumeration values:

  • enabled

  • disabled

detail

String

This parameter is returned only when the tracker status is error. It indicates the cause of the abnormal status, and its value can be bucketPolicyError, noBucket, or arrears.

is_support_trace_files_encryption

Boolean

Whether trace files are encrypted during transfer to an OBS bucket. This parameter must be used together with kms_id. This function is supported only when the value of tracker_type is system.

obs_info

ObsInfo object

Information about the bucket to which traces are transferred.

data_bucket

DataBucketQuery object

Information about the bucket tracked by a data tracker. This parameter is valid only when the value of tracker_type is data.

Table 6 Lts

Parameter

Type

Description

is_lts_enabled

Boolean

Whether traces are synchronized to LTS for trace search and analysis.

log_group_name

String

Name of the log group that CTS creates in LTS.

log_topic_name

String

Name of the log stream that CTS creates in LTS.

Table 7 ObsInfo

Parameter

Type

Description

bucket_name

String

OBS bucket name. The value contains 3 to 63 characters and must start with a number or lowercase letter. Only lowercase letters, numbers, hyphens (-), and periods (.) are allowed.

file_prefix_name

String

File name prefix to mark trace files that need to be stored in an OBS bucket. The value contains 0 to 64 characters. Only letters, numbers, hyphens (-), underscores (_), and periods (.) are allowed.

is_obs_created

Boolean

Whether the OBS bucket is automatically created by the tracker.

is_authorized_bucket

Boolean

Whether CTS has been granted permissions to perform operations on the OBS bucket.

bucket_lifecycle

Long

Duration that traces are stored in the OBS bucket. This parameter is valid only when tracker_type is set to data.

Table 8 DataBucketQuery

Parameter

Type

Description

data_bucket_name

String

OBS bucket name. The value contains 3 to 63 characters and must start with a number or lowercase letter. Only lowercase letters, numbers, hyphens (-), and periods (.) are allowed.

search_enabled

Boolean

Whether the logs of the tracked bucket can be searched.

data_event

Array of strings

Name of the bucket tracked by a data tracker.

  • This parameter is mandatory when you enable or disable a data tracker.

  • This parameter is unavailable for a management tracker.

  • Once a tracker is created, the bucket that it tracks cannot be changed.

Enumeration values:

  • WRITE

  • READ

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, in the format of CTS.XXX.

error_msg

String

Error message.

Example Requests

  • Creating a management tracker

    POST 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" : 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",
      "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 Responses

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",
  "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"
  },
  "log_file_validate" : {
    "is_support_validate" : true
  },
  "tracker_name" : "system",
  "tracker_type" : "system",
  "status" : "enabled"
}

Status Codes

Status Code

Description

201

The request is successful.

400

The server failed to process the request.

401

The request is rejected due to authentication failure.

403

The server understood the request but refused to authorize it.

404

The requested resource does not exist.

500

The server has received the request but encountered an internal error.

503

The requested service is unavailable. The client should not repeat the request without modifications.

Error Codes

See Error Codes.