forked from docs/doc-exports
liusiying01
128b7e694f
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: liusiying01 <liusiying@huawei.com> Co-committed-by: liusiying01 <liusiying@huawei.com>
211 lines
18 KiB
HTML
211 lines
18 KiB
HTML
<a name="cts_api_632"></a><a name="cts_api_632"></a>
|
|
|
|
<h1 class="topictitle1">Modifying a Tracker</h1>
|
|
<div id="body8662426"><div class="section" id="cts_api_632__en-us_topic_0257057097_section1672601019405"><h4 class="sectiontitle">Function</h4><p id="cts_api_632__en-us_topic_0257057097_p97271610204011">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_632__en-us_topic_0257057097_section072751011402"><h4 class="sectiontitle">URI</h4><p id="cts_api_632__en-us_topic_0257057097_p5728151024016">PUT /v1.0/{project_id}/tracker/{tracker_name}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_632__en-us_topic_0257057097_table8736181034015" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="cts_api_632__en-us_topic_0257057097_row12735610154011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="cts_api_632__en-us_topic_0257057097_p1737141064011">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_632__en-us_topic_0257057097_p1273713107403">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_632__en-us_topic_0257057097_p17381910134014">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_632__en-us_topic_0257057097_p1873810105406">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_632__en-us_topic_0257057097_row1736111064015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p1273818108409">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p18740151019403">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_632__en-us_topic_0257057097_p674131017401">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_632__en-us_topic_0257057097_p8741610184018">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>
|
|
<tr id="cts_api_632__en-us_topic_0257057097_row373610102405"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p6742810164012">tracker_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p20742710184013">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_632__en-us_topic_0257057097_p57435104404">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_632__en-us_topic_0257057097_p10743161016404">Tracker name. Currently, only one tracker is allowed for each tenant. The tracker name is <strong id="cts_api_632__en-us_topic_0257057097_b6417141512319">system</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_632__en-us_topic_0257057097_section374421013408"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_632__en-us_topic_0257057097_request_UpdateTrackerRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="cts_api_632__en-us_topic_0257057097_row37531810154016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="cts_api_632__en-us_topic_0257057097_p2761131017405">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_632__en-us_topic_0257057097_p0761131044018">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_632__en-us_topic_0257057097_p12762131074015">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_632__en-us_topic_0257057097_p6762210124015">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_632__en-us_topic_0257057097_row3757171014019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p976314101401">bucket_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p17764151015404">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_632__en-us_topic_0257057097_p776591024011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_632__en-us_topic_0257057097_p976631074016">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_632__en-us_topic_0257057097_row6759151054012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p076671019400">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_632__en-us_topic_0257057097_p10767151017405">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_632__en-us_topic_0257057097_p6767810184017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_632__en-us_topic_0257057097_p1276811014404">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_632__en-us_topic_0257057097_row17759181016403"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p1976821044015">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p117711110144012">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_632__en-us_topic_0257057097_p977681012401">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_632__en-us_topic_0257057097_p3776131074015">Tracker status. The value can be <strong id="cts_api_632__en-us_topic_0257057097_b1211633192415">enabled</strong> or <strong id="cts_api_632__en-us_topic_0257057097_b1611143312246">disabled</strong>. If you change the value to <strong id="cts_api_632__en-us_topic_0257057097_b8610241162419">disabled</strong>, the tracker stops recording traces.</p>
|
|
<p id="cts_api_632__en-us_topic_0257057097_p977781017401">Value:</p>
|
|
<ul id="cts_api_632__en-us_topic_0257057097_ul11777710154013"><li id="cts_api_632__en-us_topic_0257057097_li277761094013"><strong id="cts_api_632__en-us_topic_0257057097_b1077731084019">enabled</strong></li><li id="cts_api_632__en-us_topic_0257057097_li117781410114010"><strong id="cts_api_632__en-us_topic_0257057097_b57791310104012">disabled</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_632__en-us_topic_0257057097_row67592107407"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p15780310134016">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_632__en-us_topic_0257057097_p19780101019403">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_632__en-us_topic_0257057097_p167811610194011">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_632__en-us_topic_0257057097_p5781181019406">Whether an OBS bucket is created. If the value is <strong id="cts_api_632__en-us_topic_0257057097_b204583453111545">true</strong>, an OBS bucket will be created to store trace files. If the value is <strong id="cts_api_632__en-us_topic_0257057097_b1539183059111545">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_632__en-us_topic_0257057097_row2759101014010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p197881010164014">lts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p178914104404">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_632__en-us_topic_0257057097_p378961019401"><a href="#cts_api_632__en-us_topic_0257057097_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_632__en-us_topic_0257057097_p1879020105403">Dump LTS.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_632__en-us_topic_0257057097_request_Lts"></a><a name="en-us_topic_0257057097_request_Lts"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_632__en-us_topic_0257057097_request_Lts" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Lts</caption><thead align="left"><tr id="cts_api_632__en-us_topic_0257057097_row157982010164010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="cts_api_632__en-us_topic_0257057097_p9804131011409">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_632__en-us_topic_0257057097_p1580491012403">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_632__en-us_topic_0257057097_p1480581064019">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_632__en-us_topic_0257057097_p680518108400">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_632__en-us_topic_0257057097_row11798171014016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p680691011409">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_632__en-us_topic_0257057097_p10812181010407">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_632__en-us_topic_0257057097_p481311106401">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_632__en-us_topic_0257057097_p281312103403">Indicates whether to enable the function of dumping data to LTS.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_632__en-us_topic_0257057097_row19798101014019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p98141810124016">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_632__en-us_topic_0257057097_p11814131011409">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_632__en-us_topic_0257057097_p1181510102409">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_632__en-us_topic_0257057097_p20815111024018">Name of the log group that CTS creates in LTS.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_632__en-us_topic_0257057097_row10798610124014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p1181681013403">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_632__en-us_topic_0257057097_p10816161014020">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_632__en-us_topic_0257057097_p1381791012401">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_632__en-us_topic_0257057097_p4818181054017">Name of the log topic that CTS creates in LTS.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_632__en-us_topic_0257057097_section12824110204015"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_632__en-us_topic_0257057097_p1882431024011">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_632__en-us_topic_0257057097_section13825610184015"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="cts_api_632__en-us_topic_0257057097_screen208261310104011">PUT https://{endpoint}/v1.0/{project_id}/tracker/system
|
|
|
|
{
|
|
"bucket_name" : "my_created_bucket",
|
|
"file_prefix_name" : "some_folder",
|
|
"is_obs_created": true,
|
|
"lts": {
|
|
"is_lts_enabled": true,
|
|
"log_group_name": "CTS",
|
|
"log_topic_name": 'system-trace'
|
|
},
|
|
"status" : "disabled"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="cts_api_632__en-us_topic_0257057097_section984411074020"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_632__en-us_topic_0257057097_p11844171024018">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_632__en-us_topic_0257057097_section5845181074012"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_632__en-us_topic_0257057097_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_632__en-us_topic_0257057097_row11848181074011"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cts_api_632__en-us_topic_0257057097_p19851710124018">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_632__en-us_topic_0257057097_p178511610134018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_632__en-us_topic_0257057097_row484821015405"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p2852151074019">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p1685371054016">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_632__en-us_topic_0257057097_row108485103406"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p8853610124014">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p9854151017400">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_632__en-us_topic_0257057097_row5848131015409"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p148541810124014">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p7855171017407">The request is rejected due to authentication failure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_632__en-us_topic_0257057097_row58501910204014"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p19855161014019">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p198562010194010">The server understood the request but refused to authorize it.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_632__en-us_topic_0257057097_row10850171084014"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p1685681016404">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p12857161034015">The server failed to find the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_632__en-us_topic_0257057097_row98506105403"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_632__en-us_topic_0257057097_p128573107408">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_632__en-us_topic_0257057097_p138578102408">The request failed to be executed or some trackers failed to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_632__en-us_topic_0257057097_section18586104403"><h4 class="sectiontitle">Error Codes</h4><p id="cts_api_632__en-us_topic_0257057097_p08595103402">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>
|
|
|