Modifying a Tracker

Function

This API is used to modify configurations of a tracker, including trace transfer to OBS buckets, key event notifications, trace file encryption, management trace searching using Log Tank Service (LTS), trace file integrity check, and tracker enablement or disablement. Modifying tracker parameters does not affect the collected operation records. After the modification is complete, the new settings are immediately applied to operation recording.

URI

PUT /v1.0/{project_id}/tracker/{tracker_name}

Table 1 Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Identifies a project. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.
tracker_name	Yes	String	Indicates the tracker name. Currently, only one management tracker is available for one account and the tracker name is system.

Request Parameters

Table 2 Request body parameters
Parameter	Mandatory	Type	Description
bucket_name	No	String	Indicate the name of an OBS bucket. A name 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	Indicates a file name prefix to mark trace files that need to be stored in an OBS bucket. A prefix contains up to 64 characters. Only letters, numbers, hyphens (-), underscores (_), and periods (.) are allowed.
status	No	String	Indicates the status of a tracker. The value can be enabled or disabled. If you change the value to disabled, the tracker stops recording traces. '.' and '_' can contain 0 to 64 characters. Enumeration values: enabled disabled
is_obs_created	No	Boolean	Indicates whether to create an OBS bucket. 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. A bucket name contains 3 to 63 characters and can consist of lowercase letters, numbers, a period (.) and a hyphen (-).
is_support_trace_files_encryption	No	Boolean	Indicates whether trace files are encrypted during transfer to an OBS bucket. This parameter must be used together with kms_id.
kms_id	No	String	Identifies a key used for trace file encryption. The key ID is obtained from Key Management Service (KMS). It is mandatory when is_support_trace_files_encryption is set to true.
lts	No	Lts object	Indicates detail about trace analysis.
log_file_validate	No	LogFileValidate object	Indicates detail about file verification.

Table 3 Lts
Parameter	Mandatory	Type	Description
is_lts_enabled	Yes	Boolean	Indicates whether traces are synchronized to LTS for trace analysis.
log_group_name	Yes	String	Indicates the name of the log group that CTS creates in LTS.
log_topic_name	Yes	String	Indicates the name of the log stream that CTS creates in LTS.

Table 4 LogFileValidate
Parameter	Mandatory	Type	Description
is_support_validate	Yes	Boolean	Indicates whether trace file verification is enabled.

Response Parameters

None

Example Requests

PUT https://{endpoint}/v1.0/{project_id}/tracker/system

{ 
 "bucket_name" : "my_created_bucket", 
 "file_prefix_name" : "some_folder", 
 "is_obs_created": true,  
 "is_support_trace_files_encryption": true, 
 "kms_id": "13a4207c-7abe-4b68-8510-16b84c3b5504",
 "lts": {
   "is_lts_enabled": true,
   "log_group_name": 'CTS",
   "log_topic_name": 'system-trace'
 },
 "log_file_validate": {
 "is_support_validate": true
 }, 
 "status" : "disabled"   
}

Example Responses

None

Status Codes

Status Code	Description
200	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 server failed to find the requested resource.
500	The server has received the request but encountered an internal error, or some trackers failed to be deleted.

Error Codes

See Error Codes.

Parent topic: Tracker Management

Была ли эта статья полезна?

Поддержка Юридические документы