Getting Started

Involved APIs

For token-based authentication, you must obtain a token and add X-Auth-Token to the request header when calling an API.

• IAM API used to obtain a token
• CTS API used to create a tracker

Procedure

1. Obtain a token by referring to Authentication.
2. Send POST /v1.0/ {project_id} /tracker.
3. Add Content-Type and X-Auth-Token to the request header.
4. Set parameters in the request body as follows:

   POST /v1.0/{project_id}/tracker
   {
    "bucket_name": "obs-f1da",  //Name of an Object Storage Service (OBS) bucket to which traces will be transferred. This parameter is mandatory and its value is a string.
     "is_support_trace_files_encryption": true,  //Whether trace files will be encrypted during transfer. This parameter is optional and its value is of boolean type.
    "kms_id": "13a4207c-7abe-4b68-8510-16b84c3b5504",  //ID of the key for trace file encryption. When is_support_trace_files_encryption is set to true, this parameter is mandatory.
    "is_obs_created": true,  //Whether a new OBS bucket will be created. This parameter is optional and its value is of boolean type.
    "file_prefix_name": "yO8Q",   //File name prefix to mark trace files that need to be stored in OBS. This parameter is optional and its value is a string.
     "log_file_validate": {
    "is_support_validate": true  //Whether trace files will be verified. This parameter is optional and its value is of boolean type.
    }
   }

   If the request is successful, information about the created tracker is returned.

   {
    "bucket_name": "obs-f1da",
    "file_prefix_name": "yO8Q",
    "is_obs_created": true, 
    "is_support_trace_files_encryption": true, 
    "kms_id": "13a4207c-7abe-4b68-8510-16b84c3b5504",   
     "log_file_validate": {
    "is_support_validate": true
    },
   "tracker_name": "system",  //Tracker name
   "status": "enabled"  //Tracker status
   } 

   If the request fails, an error code and error message are returned. For details, see Error Codes.