vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/cts/api-ref/cts_api_0322.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

394 lines
35 KiB
HTML
Raw Permalink Blame History

<a name="cts_api_0322"></a><a name="cts_api_0322"></a>
<h1 class="topictitle1">Modifying a Tracker</h1>
<div id="body8662426"><div class="section" id="cts_api_0322__en-us_topic_0000001213559237_section1315718478488"><h4 class="sectiontitle">Function</h4><p id="cts_api_0322__en-us_topic_0000001213559237_p81581047154813">This API is used to modify configurations of a tracker, including trace transfer to OBS buckets, key event notifications, trace file encryption, trace search and analysis using LTS, trace file integrity check, and tracker enablement or disablement. Modifying tracker parameters does not affect the existing operation records. After the modification is complete, the new rules are immediately applied to operation recording.</p>
</div>
<div class="section" id="cts_api_0322__en-us_topic_0000001213559237_section5158134744817"><h4 class="sectiontitle">URI</h4><p id="cts_api_0322__en-us_topic_0000001213559237_p15158194710488">PUT /v3/{project_id}/tracker</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0322__en-us_topic_0000001213559237_table8158647124818" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="cts_api_0322__en-us_topic_0000001213559237_row31582475486"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="cts_api_0322__en-us_topic_0000001213559237_p15159647164816">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_0322__en-us_topic_0000001213559237_p1315964715489">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_0322__en-us_topic_0000001213559237_p141591947114816">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_0322__en-us_topic_0000001213559237_p615916471481">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0322__en-us_topic_0000001213559237_row11158174716487"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p14159124784815">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p141599477487">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1915914475489">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p4159847104815">Project ID. For details, see <a href="cts_api_0005.html">Obtaining an Account ID and Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0322__en-us_topic_0000001213559237_section1159194710485"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0322__en-us_topic_0000001213559237_request_UpdateTrackerRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="cts_api_0322__en-us_topic_0000001213559237_row2160114704819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="cts_api_0322__en-us_topic_0000001213559237_p816184717486">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_0322__en-us_topic_0000001213559237_p11161947154817">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_0322__en-us_topic_0000001213559237_p01615472486">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_0322__en-us_topic_0000001213559237_p11616479486">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0322__en-us_topic_0000001213559237_row1016012477480"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1616112472489">tracker_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p121619471484">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1716114754815">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p716194754820">Tracker type. The value can be <strong id="cts_api_0322__en-us_topic_0000001213559237_b1986629475598">system</strong> (management tracker).</p>
<p id="cts_api_0322__en-us_topic_0000001213559237_p6161947154816">Enumerated values:</p>
<ul id="cts_api_0322__en-us_topic_0000001213559237_ul816124719484"><li id="cts_api_0322__en-us_topic_0000001213559237_li016194718487"><strong id="cts_api_0322__en-us_topic_0000001213559237_b916214720484">system</strong></li></ul>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row16160047114816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p3162134711480">tracker_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p131622476486">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1316211475486">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p916284714818">Tracker name. When <strong id="cts_api_0322__en-us_topic_0000001213559237_b266657625598">tracker_type</strong> is set to <strong id="cts_api_0322__en-us_topic_0000001213559237_b7046074715598">system</strong>, the default value <strong id="cts_api_0322__en-us_topic_0000001213559237_b16263592675598">system</strong> is used. </p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row1616024734815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p19162947144811">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1516284712483">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1116224714811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p141624478487">Tracker status. The value can be <strong id="cts_api_0322__en-us_topic_0000001213559237_b2374803045598">enabled</strong> or <strong id="cts_api_0322__en-us_topic_0000001213559237_b5877297385598">disabled</strong>. If you change the value to <strong id="cts_api_0322__en-us_topic_0000001213559237_b11383089195598">disabled</strong>, the tracker stops recording traces.</p>
<p id="cts_api_0322__en-us_topic_0000001213559237_p416244794816">Enumerated values:</p>
<ul id="cts_api_0322__en-us_topic_0000001213559237_ul1116294724811"><li id="cts_api_0322__en-us_topic_0000001213559237_li14163104711480"><strong id="cts_api_0322__en-us_topic_0000001213559237_b5163447184820">enabled</strong></li><li id="cts_api_0322__en-us_topic_0000001213559237_li8163194724811"><strong id="cts_api_0322__en-us_topic_0000001213559237_b716354724812">disabled</strong></li></ul>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row121607476481"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p8163447164810">is_lts_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p161638475484">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p5163347124816">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1216354718483">Whether to enable trace analysis.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row11160947134814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p18164247174811">obs_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p19164347184817">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p9164104715486"><a href="#cts_api_0322__en-us_topic_0000001213559237_request_TrackerObsInfo">TrackerObsInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1316414710489">Configurations of an OBS bucket to which traces will be transferred.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cts_api_0322__en-us_topic_0000001213559237_request_TrackerObsInfo"></a><a name="en-us_topic_0000001213559237_request_TrackerObsInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0322__en-us_topic_0000001213559237_request_TrackerObsInfo" frame="border" border="1" rules="all"><caption><b>Table 3 </b>TrackerObsInfo</caption><thead align="left"><tr id="cts_api_0322__en-us_topic_0000001213559237_row016764712486"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="cts_api_0322__en-us_topic_0000001213559237_p19168134711487">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_0322__en-us_topic_0000001213559237_p15168134719488">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_0322__en-us_topic_0000001213559237_p3168124764814">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_0322__en-us_topic_0000001213559237_p2168174713486">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0322__en-us_topic_0000001213559237_row101671947144814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p616819470486">bucket_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p5168144724814">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p61681471483">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p6169174719483">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_0322__en-us_topic_0000001213559237_row016784774811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1416911473483">file_prefix_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p3169174713483">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p181691479487">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p181691647124818">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_0322__en-us_topic_0000001213559237_row816724712489"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1216974716484">is_obs_created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p11169114754812">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p13169184794817">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1716924754812">Whether an OBS bucket is created. If the value is <strong id="cts_api_0322__en-us_topic_0000001213559237_b7801214055598">true</strong>, an OBS bucket will be created to store trace files. If the value is <strong id="cts_api_0322__en-us_topic_0000001213559237_b19474926795598">false</strong>, trace files will be stored in an existing OBS bucket.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row5168124734820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p117064711486">compress_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p21711147144815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p19171174716488">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1171154716482">Compression type. The value can be JSON (no compression) or GZIP (compression). The default format is GZIP.</p>
<p id="cts_api_0322__en-us_topic_0000001213559237_p517119471483">Enumerated values:</p>
<ul id="cts_api_0322__en-us_topic_0000001213559237_ul917184764816"><li id="cts_api_0322__en-us_topic_0000001213559237_li1317116479480"><strong id="cts_api_0322__en-us_topic_0000001213559237_b12171134744818">gzip</strong></li><li id="cts_api_0322__en-us_topic_0000001213559237_li131713470480"><strong id="cts_api_0322__en-us_topic_0000001213559237_b4171114714814">json</strong></li></ul>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row31681947174814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p8171144711486">is_sort_by_service</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1517184712487">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p117112473488">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0322__en-us_topic_0000001213559237_p14171347114810">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 <strong id="cts_api_0322__en-us_topic_0000001213559237_b2648474485599">true</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0322__en-us_topic_0000001213559237_section19174947144820"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0322__en-us_topic_0000001213559237_p21748473489"><strong id="cts_api_0322__en-us_topic_0000001213559237_b1075013813355">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0322__en-us_topic_0000001213559237_response_FailedRsp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0322__en-us_topic_0000001213559237_row12174184784818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="cts_api_0322__en-us_topic_0000001213559237_p817516479489">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_0322__en-us_topic_0000001213559237_p11175144710483">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_0322__en-us_topic_0000001213559237_p18175647124818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0322__en-us_topic_0000001213559237_row12175947144810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p14175947104813">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1617534720482">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p7175144724818">Error code. Format: <strong id="cts_api_0322__en-us_topic_0000001213559237_b2554673785599">CTS.</strong><em id="cts_api_0322__en-us_topic_0000001213559237_i1618025485599">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row1617534713482"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p5175194734818">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p19176154784810">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1517624774817">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0322__en-us_topic_0000001213559237_p1017613472487"><strong id="cts_api_0322__en-us_topic_0000001213559237_b107576387357">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0322__en-us_topic_0000001213559237_table11176164794814" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0322__en-us_topic_0000001213559237_row15176154794814"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="cts_api_0322__en-us_topic_0000001213559237_p01761747114814">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_0322__en-us_topic_0000001213559237_p14177164711485">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_0322__en-us_topic_0000001213559237_p14177947174815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0322__en-us_topic_0000001213559237_row8176134717481"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p3177164724814">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p10177447114815">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p9177104715484">Error code. Format: <strong id="cts_api_0322__en-us_topic_0000001213559237_b536731957">CTS.</strong><em id="cts_api_0322__en-us_topic_0000001213559237_i1201607445">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row16176134713486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p12177114718489">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p141771447134812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1617714734813">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0322__en-us_topic_0000001213559237_p11771247124819"><strong id="cts_api_0322__en-us_topic_0000001213559237_b9761113873520">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0322__en-us_topic_0000001213559237_table141771147124812" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0322__en-us_topic_0000001213559237_row17177124712487"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="cts_api_0322__en-us_topic_0000001213559237_p8178114714812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="cts_api_0322__en-us_topic_0000001213559237_p21781547144816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="cts_api_0322__en-us_topic_0000001213559237_p18178124718486">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0322__en-us_topic_0000001213559237_row1117854764813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p6178164714480">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p11783478483">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p161781347104819">Error code. Format: <strong id="cts_api_0322__en-us_topic_0000001213559237_b734858567">CTS.</strong><em id="cts_api_0322__en-us_topic_0000001213559237_i317450084">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row41781647164817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p14178154716484">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p121799475488">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p117944717489">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0322__en-us_topic_0000001213559237_p151791347194813"><strong id="cts_api_0322__en-us_topic_0000001213559237_b576619383356">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0322__en-us_topic_0000001213559237_table417917479487" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0322__en-us_topic_0000001213559237_row15179347104811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="cts_api_0322__en-us_topic_0000001213559237_p1417920472487">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="cts_api_0322__en-us_topic_0000001213559237_p21791847184816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="cts_api_0322__en-us_topic_0000001213559237_p21801847114820">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0322__en-us_topic_0000001213559237_row1917954734811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p918024720482">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p191802474484">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p3180144714481">Error code. Format: <strong id="cts_api_0322__en-us_topic_0000001213559237_b1447324753">CTS.</strong><em id="cts_api_0322__en-us_topic_0000001213559237_i1155506222">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row517984744819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p20180124717487">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p9180164724815">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1418018474484">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0322__en-us_topic_0000001213559237_p161800473484"><strong id="cts_api_0322__en-us_topic_0000001213559237_b27748386351">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0322__en-us_topic_0000001213559237_table31801747144818" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0322__en-us_topic_0000001213559237_row91801547174815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="cts_api_0322__en-us_topic_0000001213559237_p81811647144815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="cts_api_0322__en-us_topic_0000001213559237_p12181114720489">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="cts_api_0322__en-us_topic_0000001213559237_p16393247104819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0322__en-us_topic_0000001213559237_row4180147114814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p17393247134815">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1239317473488">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p039364794810">Error code. Format: <strong id="cts_api_0322__en-us_topic_0000001213559237_b296579536">CTS.</strong><em id="cts_api_0322__en-us_topic_0000001213559237_i940385797">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row818004720482"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p11393174734812">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p33938471485">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p63931847164820">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0322__en-us_topic_0000001213559237_p5393647194816"><strong id="cts_api_0322__en-us_topic_0000001213559237_b1377893818353">Status code: 503</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0322__en-us_topic_0000001213559237_table91821347174812" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0322__en-us_topic_0000001213559237_row218216474484"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="cts_api_0322__en-us_topic_0000001213559237_p1339354754818">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="cts_api_0322__en-us_topic_0000001213559237_p1339364718481">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="cts_api_0322__en-us_topic_0000001213559237_p239384713486">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0322__en-us_topic_0000001213559237_row16182104714481"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p14393174794810">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p10393194764810">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p103931547154811">Error code. Format: <strong id="cts_api_0322__en-us_topic_0000001213559237_b1419783792">CTS.</strong><em id="cts_api_0322__en-us_topic_0000001213559237_i517869637">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row3182144711486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p639304710482">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p33931147174816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="cts_api_0322__en-us_topic_0000001213559237_p539313476485">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0322__en-us_topic_0000001213559237_section93931847194818"><h4 class="sectiontitle">Example Request</h4><ul id="cts_api_0322__en-us_topic_0000001213559237_ul23931447144820"><li id="cts_api_0322__en-us_topic_0000001213559237_li183931447194818">Modifying a management tracker<pre class="screen" id="cts_api_0322__en-us_topic_0000001213559237_screen4393144754817">PUT 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" : false,
"is_support_trace_files_encryption" : false,
"kms_id" : "",
"is_support_validate" : false,
"status" : "enabled"
}</pre>
</li></ul>
</div>
<div class="section" id="cts_api_0322__en-us_topic_0000001213559237_section1239413475481"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0322__en-us_topic_0000001213559237_p17394194718482">None</p>
</div>
<div class="section" id="cts_api_0322__en-us_topic_0000001213559237_section139414476486"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0322__en-us_topic_0000001213559237_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_0322__en-us_topic_0000001213559237_row4185204716483"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cts_api_0322__en-us_topic_0000001213559237_p1039434710483">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_0322__en-us_topic_0000001213559237_p6394124724819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0322__en-us_topic_0000001213559237_row10185347174815"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p6394184711489">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p63941447174813">The request is successful.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row818524764814"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p539484716485">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1439424719486">The server failed to process the request.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row13185947104811"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1539474719482">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p2394184734819">The request is rejected due to authentication failure.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row17185947164820"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p13394124764813">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1339454734813">The server understood the request but refused to authorize it.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row918534724813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p193941847164811">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1639474794819">The server failed to find the requested resource.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row9185547194816"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p9394174715481">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p93941747134811">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="cts_api_0322__en-us_topic_0000001213559237_row121851947144820"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0322__en-us_topic_0000001213559237_p193941347164814">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0322__en-us_topic_0000001213559237_p1139419475484">The requested service is invalid. The client should not repeat the request without modifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0322__en-us_topic_0000001213559237_section73941447124810"><h4 class="sectiontitle">Error Code</h4><p id="cts_api_0322__en-us_topic_0000001213559237_p15394104764818">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_0320.html">Tracker Management</a></div>
</div>
</div>
View Git Blame Copy Permalink