vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/cts/api-ref/cts_api_0125.html
Liu, Siying 61db61b4e5 CTS API 20230612 version. 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-04-18 10:17:02 +00:00

459 lines
38 KiB
HTML
Raw Permalink Blame History

<a name="cts_api_0125"></a><a name="cts_api_0125"></a>
<h1 class="topictitle1">Creating a Tracker</h1>
<div id="body8662426"><div class="section" id="cts_api_0125__en-us_topic_0257057505_section132410474711"><h4 class="sectiontitle">Function</h4><p id="cts_api_0125__en-us_topic_0257057505_p626343471">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. Traces are retained in the CTS console for seven days. For long-term storage, you can enable Object Storage Service (OBS) and deliver real-time operation records to OBS buckets.</p>
</div>
<div class="section" id="cts_api_0125__en-us_topic_0257057505_section2278484710"><h4 class="sectiontitle">URI</h4><p id="cts_api_0125__en-us_topic_0257057505_p122814404716">POST /v1.0/{project_id}/tracker</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0125__en-us_topic_0257057505_table17317444714" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="cts_api_0125__en-us_topic_0257057505_row1429846479"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="cts_api_0125__en-us_topic_0257057505_p153114416471">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="cts_api_0125__en-us_topic_0257057505_p19331644475">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="cts_api_0125__en-us_topic_0257057505_p2343454717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="cts_api_0125__en-us_topic_0257057505_p43517444717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0125__en-us_topic_0257057505_row133018454710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p203613404714">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p1937124144711">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p1038184144719">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p4391042474">Project ID. For details about how to obtain a project ID, see <a href="cts_api_0005.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0125__en-us_topic_0257057505_section15401419471"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0125__en-us_topic_0257057505_request_CreateTrackerRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="cts_api_0125__en-us_topic_0257057505_row124115474719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="cts_api_0125__en-us_topic_0257057505_p9454418475">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="cts_api_0125__en-us_topic_0257057505_p4466416474">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="cts_api_0125__en-us_topic_0257057505_p18478414471">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="cts_api_0125__en-us_topic_0257057505_p174811434718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0125__en-us_topic_0257057505_row14113474719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p154913484718">bucket_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p05018414474">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p1451114144711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p1152145479">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.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row18420412471"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p8531846475">file_prefix_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p195411412479">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p65713414717">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p25864104718">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 (.).</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row1542134154712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p0592045473">is_obs_created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p66020464720">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p2615410477">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p56211415475">Whether an OBS bucket is created. The default value is <strong id="cts_api_0125__en-us_topic_0257057505_b133381216181519">false</strong>. If the value is <strong id="cts_api_0125__en-us_topic_0257057505_b5498435101513">true</strong>, an OBS bucket will be created to store trace files. If the value is <strong id="cts_api_0125__en-us_topic_0257057505_b1349919353159">false</strong>, trace files will be stored in an existing OBS bucket. A bucket name contains 3 to 64 characters, including digits, letters, and a hyphen (-) or a period (.).</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row10421484715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p20637464716">is_support_trace_files_encryption</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p96412424715">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p9653412479">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p1966124174715">Whether trace files are encrypted during transfer to an OBS bucket. This parameter must be used with <strong id="cts_api_0125__en-us_topic_0257057505_b736447830105736">kms_id</strong>.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row7421741473"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p12672047474">kms_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p196911418473">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p97044124711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p1371194124719">Key ID used for transferring and encrypting trace files. This key ID is obtained from Key Management Service (KMS). This parameter is mandatory when <strong id="cts_api_0125__en-us_topic_0257057505_b5624721193315">is_support_trace_files_encryption</strong> is set to <strong id="cts_api_0125__en-us_topic_0257057505_b46241721103320">true</strong>.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row174211414472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p672748478">lts</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p87384134719">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p157411411474"><a href="#cts_api_0125__en-us_topic_0257057505_request_Lts">Lts</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p1975144124718">Trace analysis.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row74374104712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p1876443471">log_file_validate</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p19771474719">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p15787413473"><a href="#cts_api_0125__en-us_topic_0257057505_request_LogFileValidate">LogFileValidate</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p47915494719">File verification.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cts_api_0125__en-us_topic_0257057505_request_Lts"></a><a name="en-us_topic_0257057505_request_Lts"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0125__en-us_topic_0257057505_request_Lts" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Lts</caption><thead align="left"><tr id="cts_api_0125__en-us_topic_0257057505_row781244472"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="cts_api_0125__en-us_topic_0257057505_p2831542478">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="cts_api_0125__en-us_topic_0257057505_p1841949470">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="cts_api_0125__en-us_topic_0257057505_p18859412474">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="cts_api_0125__en-us_topic_0257057505_p3871645474">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0125__en-us_topic_0257057505_row13811945478"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p138814424713">is_lts_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p1389244479">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p179012416471">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p9924417478">Whether the LTS search function is enabled.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row188111412474"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p1993124184710">log_group_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p594140471">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p189510464710">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p15961443475">Name of the log group that CTS creates in LTS.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row28113413476"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p9973420474">log_topic_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p6981474713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p1299174144711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p21006417479">Name of the log topic that CTS creates in LTS.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cts_api_0125__en-us_topic_0257057505_request_LogFileValidate"></a><a name="en-us_topic_0257057505_request_LogFileValidate"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0125__en-us_topic_0257057505_request_LogFileValidate" frame="border" border="1" rules="all"><caption><b>Table 4 </b>LogFileValidate</caption><thead align="left"><tr id="cts_api_0125__en-us_topic_0257057505_row15101745476"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="cts_api_0125__en-us_topic_0257057505_p710317419475">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="cts_api_0125__en-us_topic_0257057505_p10104184144715">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="cts_api_0125__en-us_topic_0257057505_p1710534114716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="cts_api_0125__en-us_topic_0257057505_p81060434715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0125__en-us_topic_0257057505_row14101194194716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p110714415473">is_support_validate</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p710818419476">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p181097414474">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="cts_api_0125__en-us_topic_0257057505_p611094174715">Whether to enable trace file verification.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0125__en-us_topic_0257057505_section1111164174717"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0125__en-us_topic_0257057505_p1011264164715"><strong id="cts_api_0125__en-us_topic_0257057505_b20850171318407">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0125__en-us_topic_0257057505_response_CreateTrackerResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0125__en-us_topic_0257057505_row0114940470"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="cts_api_0125__en-us_topic_0257057505_p81179415479">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="cts_api_0125__en-us_topic_0257057505_p511915424715">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="cts_api_0125__en-us_topic_0257057505_p1512094114711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0125__en-us_topic_0257057505_row911474194712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p1212110419477">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p151221943473">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p141236474713">Unique tracker ID.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row211414414477"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p412416415471">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p7125843478">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p51268412471">Timestamp when the tracker was created.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row611434204710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p201271412477">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p151288434716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p111296413476">Account ID. For details about how to obtain an account ID, see <a href="cts_api_0005.html">Obtaining an Account ID</a>.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row13114549479"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p113016444716">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p213174174715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p813244154718">Project ID.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row311415424715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p713414424712">is_support_trace_files_encryption</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p41351414472">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p81368410471">Whether trace files are encrypted during transfer to an OBS bucket. This parameter must be used with <strong id="cts_api_0125__en-us_topic_0257057505_b581117114105736">kms_id</strong>.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row411484104714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p51373474719">kms_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p11138114194719">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p9139154124715">Key ID used for transferring and encrypting trace files. This key ID is obtained from Key Management Service (KMS). This parameter is mandatory when <strong id="cts_api_0125__en-us_topic_0257057505_b111871523153320">is_support_trace_files_encryption</strong> is set to <strong id="cts_api_0125__en-us_topic_0257057505_b6187202311334">true</strong>.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row311417418474"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p4139144144719">obs_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p1614112415478"><a href="#cts_api_0125__en-us_topic_0257057505_response_ObsInfo">ObsInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p514244154710">Information about the bucket to which traces are transferred.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row10115184144710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p114315418478">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p1514416417474">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p414584144713">Status of a tracker. The value <strong id="cts_api_0125__en-us_topic_0257057505_b102341667447">enabled</strong> indicates normal status.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row81152418479"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p4146541474">tracker_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p1914718410471">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p121483474719">Tracker name.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row14115134194718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p81497434714">tracker_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p1715017415477">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p1715216454711">Tracker type.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row81151444479"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p181535413474">group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p14154443479">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p11551541474">Unique ID of a log group.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row20115448475"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p11156348472">stream_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p1815717434716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p13158114144716">Unique ID of a log stream.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row201151413471"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p8159841479">lts</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p131608484713"><a href="#cts_api_0125__en-us_topic_0257057505_response_Lts">Lts</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p51611411471">Trace analysis.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row71155404714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p111628419475">is_support_validate</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p111633454719">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p181643415471">Whether to enable trace file verification. This function is supported only when the value of <strong id="cts_api_0125__en-us_topic_0257057505_b8122384715">tracker_type</strong> is <strong id="cts_api_0125__en-us_topic_0257057505_b111253154714">system</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cts_api_0125__en-us_topic_0257057505_response_ObsInfo"></a><a name="en-us_topic_0257057505_response_ObsInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0125__en-us_topic_0257057505_response_ObsInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ObsInfo</caption><thead align="left"><tr id="cts_api_0125__en-us_topic_0257057505_row121657484716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="cts_api_0125__en-us_topic_0257057505_p191681746475">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="cts_api_0125__en-us_topic_0257057505_p121690434718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="cts_api_0125__en-us_topic_0257057505_p7170846476">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0125__en-us_topic_0257057505_row31658419474"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p1817110414474">bucket_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p817217454715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p1917312414473">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.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row916515411470"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p817410494713">file_prefix_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p31751542477">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p121763444720">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 (.).</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row716619410479"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p1917784184711">is_obs_created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p111781414718">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p201808411477">Whether the OBS bucket is automatically created by the tracker.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row1916618419478"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p11816474714">is_authorized_bucket</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p18182144154711">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p12183104194717">Whether CTS has been granted permissions to perform operations on the OBS bucket.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row616614434716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p1618411415473">bucket_lifecycle</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p131855454711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p8186114204710">Duration that traces are stored in the OBS bucket. This parameter is valid when <strong id="cts_api_0125__en-us_topic_0257057505_b59894025231435">tracker_type</strong> is set to <strong id="cts_api_0125__en-us_topic_0257057505_b53259102231435">data</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cts_api_0125__en-us_topic_0257057505_response_Lts"></a><a name="en-us_topic_0257057505_response_Lts"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0125__en-us_topic_0257057505_response_Lts" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Lts</caption><thead align="left"><tr id="cts_api_0125__en-us_topic_0257057505_row14187174124716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="cts_api_0125__en-us_topic_0257057505_p101894411472">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="cts_api_0125__en-us_topic_0257057505_p1319024154716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="cts_api_0125__en-us_topic_0257057505_p151911643474">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0125__en-us_topic_0257057505_row818717464719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p111927417474">is_lts_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p1219318418477">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p11949415479">Whether the LTS search function is enabled.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row14187114114710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p9195144204720">log_group_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p719610410477">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p101972444719">Name of the log group that CTS creates in LTS.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row518744134715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p141989420473">log_topic_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p11199741478">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0125__en-us_topic_0257057505_p18200549478">Name of the log topic that CTS creates in LTS.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0125__en-us_topic_0257057505_section1220194164719"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="cts_api_0125__en-us_topic_0257057505_screen92041545474">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
}
}</pre>
</div>
<div class="section" id="cts_api_0125__en-us_topic_0257057505_section621913484710"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0125__en-us_topic_0257057505_p622019418470"><strong id="cts_api_0125__en-us_topic_0257057505_b15951191517404">Status code: 201</strong></p>
<p id="cts_api_0125__en-us_topic_0257057505_p1122111484720">The request is successfully sent.</p>
<pre class="screen" id="cts_api_0125__en-us_topic_0257057505_screen422424144710">{
"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"
}</pre>
</div>
<div class="section" id="cts_api_0125__en-us_topic_0257057505_section298554174720"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0125__en-us_topic_0257057505_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_0125__en-us_topic_0257057505_row924594114713"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cts_api_0125__en-us_topic_0257057505_p1498616416473">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="cts_api_0125__en-us_topic_0257057505_p6987154114711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0125__en-us_topic_0257057505_row14245134144717"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p169871947472">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p1298774154716">The request is successfully sent.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row924510454716"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p0988744470">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p99883484710">The server failed to process the request.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row82451140478"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p169888418479">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p18989844475">The request is rejected due to authentication failure.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row182464412472"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p49895415475">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p189901247471">The server understood the request but refused to authorize it.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row192465416474"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p599234144718">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p1599312424712">The requested OBS bucket does not exist.</p>
</td>
</tr>
<tr id="cts_api_0125__en-us_topic_0257057505_row122461414476"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0125__en-us_topic_0257057505_p11993643479">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0125__en-us_topic_0257057505_p999412454711">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0125__en-us_topic_0257057505_section189943494719"><h4 class="sectiontitle">Error Codes</h4><p id="cts_api_0125__en-us_topic_0257057505_p19951549478">For details, see <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="cts_api_0013.html">Tracker Management</a></div>
</div>
</div>
View Git Blame Copy Permalink