forked from docs/doc-exports
Liu, Siying
61db61b4e5
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>
112 lines
9.0 KiB
HTML
112 lines
9.0 KiB
HTML
<a name="cts_api_0017"></a><a name="cts_api_0017"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Tracker</h1>
|
|
<div id="body8662426"><div class="section" id="cts_api_0017__en-us_topic_0257057510_section188192046478"><h4 class="sectiontitle">Function</h4><p id="cts_api_0017__en-us_topic_0257057510_p482304134712">This API is used to delete a tracker from CTS. Deleting a tracker has no impact on the operation records that have been generated. When you enable CTS again, you can still view those traces.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0017__en-us_topic_0257057510_section5824447470"><h4 class="sectiontitle">URI</h4><p id="cts_api_0017__en-us_topic_0257057510_p08258454719">DELETE /v1.0/{project_id}/tracker</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0017__en-us_topic_0257057510_table282844124711" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="cts_api_0017__en-us_topic_0257057510_row108267454711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="cts_api_0017__en-us_topic_0257057510_p178281543473">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_0017__en-us_topic_0257057510_p78296417474">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_0017__en-us_topic_0257057510_p16830841473">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_0017__en-us_topic_0257057510_p1883113414720">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0017__en-us_topic_0257057510_row18826104154712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_0017__en-us_topic_0257057510_p283313464711">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_0017__en-us_topic_0257057510_p4834949472">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_0017__en-us_topic_0257057510_p08351545477">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_0017__en-us_topic_0257057510_p19836104184711">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 class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0017__en-us_topic_0257057510_table18839141477" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameter</caption><thead align="left"><tr id="cts_api_0017__en-us_topic_0257057510_row15838164194714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="cts_api_0017__en-us_topic_0257057510_p208407444715">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="cts_api_0017__en-us_topic_0257057510_p19841142479">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="cts_api_0017__en-us_topic_0257057510_p38420434710">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="cts_api_0017__en-us_topic_0257057510_p48431418478">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0017__en-us_topic_0257057510_row178381411476"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cts_api_0017__en-us_topic_0257057510_p1484413424714">tracker_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cts_api_0017__en-us_topic_0257057510_p13846144104714">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cts_api_0017__en-us_topic_0257057510_p178473404717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cts_api_0017__en-us_topic_0257057510_p28481043476">Tracker name. If this parameter is not specified, all trackers of a tenant will be deleted. Currently, only one tracker is allowed for each tenant. The tracker name is <strong id="cts_api_0017__en-us_topic_0257057510_b102046491075">system</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0017__en-us_topic_0257057510_section178498415472"><h4 class="sectiontitle">Request Parameters</h4><p id="cts_api_0017__en-us_topic_0257057510_p188524484718">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0017__en-us_topic_0257057510_section385315415472"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0017__en-us_topic_0257057510_p1085416419479">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0017__en-us_topic_0257057510_section985524144718"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="cts_api_0017__en-us_topic_0257057510_screen2856144134720">DELETE https://{endpoint}/v1.0/{project_id}/tracker?tracker_name=system</pre>
|
|
</div>
|
|
<div class="section" id="cts_api_0017__en-us_topic_0257057510_section138581047474"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0017__en-us_topic_0257057510_p685913420479">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0017__en-us_topic_0257057510_section20860174104717"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0017__en-us_topic_0257057510_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_0017__en-us_topic_0257057510_row1986115412479"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cts_api_0017__en-us_topic_0257057510_p486214418477">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_0017__en-us_topic_0257057510_p1486411410478">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0017__en-us_topic_0257057510_row6861948471"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0017__en-us_topic_0257057510_p178651949473">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0017__en-us_topic_0257057510_p148666494714">The deletion is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0017__en-us_topic_0257057510_row3861124184719"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0017__en-us_topic_0257057510_p58674413478">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0017__en-us_topic_0257057510_p198681746473">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0017__en-us_topic_0257057510_row48612048471"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0017__en-us_topic_0257057510_p48695420475">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0017__en-us_topic_0257057510_p18709417474">The request is rejected due to authentication failure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0017__en-us_topic_0257057510_row1861154144717"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0017__en-us_topic_0257057510_p1787154124711">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0017__en-us_topic_0257057510_p18731744474">The server understood the request but refused to authorize it.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0017__en-us_topic_0257057510_row1486120494718"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0017__en-us_topic_0257057510_p58741149474">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0017__en-us_topic_0257057510_p387574154719">The server failed to find the requested resource or some trackers failed to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0017__en-us_topic_0257057510_row118616419476"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0017__en-us_topic_0257057510_p14876144164716">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0017__en-us_topic_0257057510_p158774414477">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_0017__en-us_topic_0257057510_section687834154714"><h4 class="sectiontitle">Error Codes</h4><p id="cts_api_0017__en-us_topic_0257057510_p48790417475">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>
|
|
|