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. To obtain more operation records, you can enable OBS and deliver operation records to OBS buckets in real time for long-term storage.

URI

POST /v3/{project_id}/tracker

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining an Account ID and Project ID.

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. Enumerated 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 to enable trace analysis.
is_organization_tracker	No	Boolean	Whether to apply the tracker configuration to the organization. This parameter is valid only for the management tracker. If the value is set to true, the audit logs of all members in the ORG organization in the current region will be transferred to the OBS bucket or LTS log stream configured for the management tracker. However, audit logs of other members cannot be viewed on the Trace List page.
management_event_selector	No	ManagementEventSelector object	Cloud services whose traces will not be transferred. Currently, the value can only be set to KMS, indicating that the createDatakey traces of KMS will not be transferred.
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 when tracker_type is set to system. This parameter must be used with kms_id.
kms_id	No	String	Key ID used for transferring and encrypting trace files. This key ID is obtained from Key Management Service (KMS). This parameter is valid 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** ManagementEventSelector
Parameter	Mandatory	Type	Description
exclude_service	No	Array of strings	Cloud services whose traces will not be transferred. Currently, the value can only be set to KMS, indicating that the createDatakey traces of KMS will not be transferred.

**Table 4** TrackerObsInfo
Parameter	Mandatory	Type	Description
bucket_name	No	String	OBS bucket name. The value contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
file_prefix_name	No	String	Prefix of trace files that need to be stored in OBS buckets. The value can contain 0 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).
is_obs_created	No	Boolean	Whether an OBS bucket is created. If the value is true, an OBS bucket will be created to store trace files. If the value is false, trace files will be stored in an existing OBS bucket.
bucket_lifecycle	No	Integer	Duration that traces are stored in the OBS bucket. This parameter is valid when tracker_type is set to data. Enumerated values: 30 60 90 180 1095
compress_type	No	String	Compression type. The value can be JSON (no compression) or GZIP (compression). The default format is GZIP. Enumerated values: gzip json
is_sort_by_service	No	Boolean	Whether to sort the path by cloud service. If this option is enabled, the cloud service name is added to the transfer file path. The default value is true.

**Table 5** DataBucket
Parameter	Mandatory	Type	Description
data_bucket_name	No	String	Name of the bucket tracked by a data tracker. This parameter is mandatory when the data tracker is enabled or disabled. 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 the data tracker is enabled or disabled. This parameter is unavailable for a management tracker. READ: read operations of an OBS object; WRITE: write operations of an OBS object. Enumerated values: WRITE READ

Response Parameters

Status code: 201

**Table 6** Response body parameters
Parameter	Type	Description
id	String	Unique tracker ID.
create_time	Long	Timestamp when the tracker was created.
kms_id	String	Key ID used for transferring and encrypting trace files. This key ID is obtained from Key Management Service (KMS). This parameter is mandatory when tracker_type is set to system and is_support_trace_files_encryption is set to true.
is_support_validate	Boolean	Whether to enable trace file verification.
is_organization_tracker	Boolean	Whether to apply the tracker configuration to the organization. This parameter is valid only for the management tracker. If the value is set to true, the audit logs of all members in the ORG organization in the current region will be transferred to the OBS bucket or LTS log stream configured for the management tracker. However, audit logs of other members cannot be viewed on the Trace List page.
management_event_selector	ManagementEventSelector object	Cloud services whose traces will not be transferred. Currently, the value can only be set to KMS, indicating that the createDatakey traces of KMS will not be transferred.
lts	Lts object	Detail about trace analysis.
tracker_type	String	Tracker type. The value can be system (management tracker), or data (data tracker). Enumerated values: system data
domain_id	String	Account ID. For details, see Obtaining an Account ID and Project ID.
project_id	String	Project ID.
tracker_name	String	Tracker name. The default value is system.
status	String	Tracker status. The value can be enabled, disabled, or error. If the value is set to error, the detail field is required for specifying the source of the error. Enumerated 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 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 when tracker_type is set to data.

**Table 7** ManagementEventSelector
Parameter	Type	Description
exclude_service	Array of strings	Cloud services whose traces will not be transferred. Currently, the value can only be set to KMS, indicating that the createDatakey traces of KMS will not be transferred.

**Table 8** Lts
Parameter	Type	Description
is_lts_enabled	Boolean	Specifies whether to enable the LTS search function.
log_group_name	String	Name of the log group that CTS creates in LTS.
log_topic_name	String	Specifies the name of the log topic that CTS creates in LTS.

**Table 9** ObsInfo
Parameter	Type	Description
bucket_name	String	OBS bucket name. The value contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
file_prefix_name	String	Prefix of trace files that need to be stored in OBS buckets. The value can contain 0 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).
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 when tracker_type is set to data.
compress_type	String	Compression type. The value can be JSON (no compression) or GZIP (compression). The default format is GZIP. Enumerated values: gzip json
is_sort_by_service	Boolean	Whether to sort the path by cloud service. If this option is enabled, the cloud service name is added to the transfer file path. The default value is true.

**Table 10** DataBucketQuery
Parameter	Type	Description
data_bucket_name	String	OBS bucket name. The value contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, digits, 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 the data tracker is enabled or disabled. This parameter is unavailable for a management tracker. Once a tracker is created, the bucket that it tracks cannot be changed. READ OBS: read operations; WRITE OBS: write operations. Enumerated values: WRITE READ

Status code: 400

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 401

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 403

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 404

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Status code: 503

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Format: CTS.XXX.
error_msg	String	Error message.

Example Request

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 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",
  "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"
}

Status Code

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	Failed to complete the request because of an internal service error.
503	The requested service is invalid. The client should not repeat the request without modifications.