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. Currently, only one management tracker can be created for a cloud account in a region. Operation records are retained for 7 days and you can check the records on the CTS console. To store records for a longer period, you can transfer records to an Object Storage Service (OBS) bucket in real time.

URI

POST /v1.0/{project_id}/tracker

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.

Request Parameters

Table 2 Request body parameters
Parameter	Mandatory	Type	Description
bucket_name	Yes	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.
is_obs_created	No	Boolean	Indicates whether to create an OBS bucket. The default value is false. 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

Status code: 201

Table 5 Response body parameters
Parameter	Type	Description
id	String	Uniquely identifies a tracker.
create_time	Long	Indicates the timestamp when the tracker was created.
domain_id	String	Identifies an account. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.
project_id	String	Identifies a project.
is_support_trace_files_encryption	Boolean	Indicates whether trace files are encrypted during transfer to an OBS bucket. This parameter must be used together with kms_id.
kms_id	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.
obs_info	ObsInfo object	Indicates information of an OBS bucket.
status	String	Indicates the status of a tracker. The value is enabled.
tracker_name	String	Indicates the tracker name.
tracker_type	String	Indicates the tracker type.
group_id	String	Identifies a log group.
stream_id	String	Identifies a log stream.
lts	Lts object	Indicates detail about trace analysis.
is_support_validate	Boolean	Indicates whether trace file verification is enabled. The verification is supported only when the value of tracker_type is system.

Table 6 ObsInfo
Parameter	Type	Description
bucket_name	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	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.
is_obs_created	Boolean	Indicates whether the OBS bucket is automatically created by the tracker.
is_authorized_bucket	Boolean	Indicates whether CTS has been granted permissions to perform operations on the OBS bucket.
bucket_lifecycle	String	Indicates the duration that traces are stored in the OBS bucket. This parameter is valid when tracker_type is set to data.

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

Example Requests

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

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" : {
    "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"
}

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 OBS bucket does not exist.
500	The server has received the request but encountered an internal error.

Error Codes

See Error Codes.

Parent topic: Tracker Management

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

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