forked from docs/doc-exports
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>
295 lines
25 KiB
HTML
295 lines
25 KiB
HTML
<a name="cts_api_0016"></a><a name="cts_api_0016"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Tracker</h1>
|
|
<div id="body8662426"><div class="section" id="cts_api_0016__en-us_topic_0257057509_section85803434716"><h4 class="sectiontitle">Function</h4><p id="cts_api_0016__en-us_topic_0257057509_p10581174174717">This API is used to query the details of a tracker. The details include the name of the tracker, name of the OBS bucket for storing traces, and prefix of the trace files stored in the OBS bucket.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0016__en-us_topic_0257057509_section1581114194710"><h4 class="sectiontitle">URI</h4><p id="cts_api_0016__en-us_topic_0257057509_p5583164174710">GET /v1.0/{project_id}/tracker</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0016__en-us_topic_0257057509_table145851847479" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="cts_api_0016__en-us_topic_0257057509_row1758412410471"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="cts_api_0016__en-us_topic_0257057509_p158720434717">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_0016__en-us_topic_0257057509_p1858811414719">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_0016__en-us_topic_0257057509_p758914414712">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_0016__en-us_topic_0257057509_p459064154712">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0016__en-us_topic_0257057509_row1558411484716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p259110417473">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p1959264184713">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p1159319484712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_0016__en-us_topic_0257057509_p1259464134719">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_0016__en-us_topic_0257057509_table85979454713" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameter</caption><thead align="left"><tr id="cts_api_0016__en-us_topic_0257057509_row75958418474"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="cts_api_0016__en-us_topic_0257057509_p12597241477">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_0016__en-us_topic_0257057509_p1159874164714">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_0016__en-us_topic_0257057509_p1459934174713">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_0016__en-us_topic_0257057509_p12600124114713">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0016__en-us_topic_0257057509_row19595648471"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p106018464715">tracker_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p2602648478">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p1160319474715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cts_api_0016__en-us_topic_0257057509_p86041464717">Tracker name. If this parameter is not specified, all trackers of a tenant will be queried. Currently, only one tracker is allowed for each tenant. The tracker name is <strong id="cts_api_0016__en-us_topic_0257057509_b1492610331571">system</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0016__en-us_topic_0257057509_section2060517474716"><h4 class="sectiontitle">Request Parameters</h4><p id="cts_api_0016__en-us_topic_0257057509_p3606164174710">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0016__en-us_topic_0257057509_section96081645473"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0016__en-us_topic_0257057509_p76103454716"><strong id="cts_api_0016__en-us_topic_0257057509_b1068748517105211">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0016__en-us_topic_0257057509_response_ListTrackerResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0016__en-us_topic_0257057509_row14611144154717"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="cts_api_0016__en-us_topic_0257057509_p2614174184712">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_0016__en-us_topic_0257057509_p206152413476">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_0016__en-us_topic_0257057509_p196163419476">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0016__en-us_topic_0257057509_row1061113416471"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p261816424711">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p86191748478">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p96206444713">Unique tracker ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row196118416478"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p962112419479">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p13623742472">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p186241146476">Timestamp when the tracker was created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row161117411476"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p56251845478">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p156262484718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p4627145478">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_0016__en-us_topic_0257057509_row11612446471"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p962716413479">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p9628194164717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p14630114104718">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row18612247476"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p11631546473">tracker_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p56328454710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p163317419474">Tracker name. The default value is <strong id="cts_api_0016__en-us_topic_0257057509_b166941236152216">system</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row261216415476"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p13635046477">tracker_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p1363614414714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p26373416470">Tracker type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row1961212494718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p136381944478">bucket_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p186391749475">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p36401245471">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_0016__en-us_topic_0257057509_row146127417479"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p564115444713">file_prefix_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p1164217418473">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p1164317414473">Prefix of trace files that need to be stored in OBS buckets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row136121540473"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p1164404144710">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p146452434712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p16646243479">Tracker status. The value can be <strong id="cts_api_0016__en-us_topic_0257057509_b20353171314446">enabled</strong>, <strong id="cts_api_0016__en-us_topic_0257057509_b43531213124416">disabled</strong>, or <strong id="cts_api_0016__en-us_topic_0257057509_b203531113184414">error</strong>. If the value is set to <strong id="cts_api_0016__en-us_topic_0257057509_b935315139442">error</strong>, the <strong id="cts_api_0016__en-us_topic_0257057509_b2354111311445">detail</strong> field is required for specifying the source of the error.</p>
|
|
<p id="cts_api_0016__en-us_topic_0257057509_p364716494718">Value:</p>
|
|
<ul id="cts_api_0016__en-us_topic_0257057509_ul36481143477"><li id="cts_api_0016__en-us_topic_0257057509_li56483416478"><strong id="cts_api_0016__en-us_topic_0257057509_b86486464720">enabled</strong></li><li id="cts_api_0016__en-us_topic_0257057509_li146496414478"><strong id="cts_api_0016__en-us_topic_0257057509_b0650142472">disabled</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row13612246479"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p136505419477">detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p36521145478">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p176531549475">This parameter is returned only when the tracker status is <strong id="cts_api_0016__en-us_topic_0257057509_b21748520491">error</strong>. It indicates the cause of the abnormal status, and its value can be <strong id="cts_api_0016__en-us_topic_0257057509_b017435218495">bucketPolicyError</strong>, <strong id="cts_api_0016__en-us_topic_0257057509_b117415218493">noBucket</strong>, or <strong id="cts_api_0016__en-us_topic_0257057509_b10174105284913">arrears</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row11612445476"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p1965464144719">is_obs_created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p196551741473">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p965624194719">Whether an OBS bucket is created. If the value is <strong id="cts_api_0016__en-us_topic_0257057509_b1054633834111543">true</strong>, an OBS bucket will be created to store trace files. If the value is <strong id="cts_api_0016__en-us_topic_0257057509_b552458149111543">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_0016__en-us_topic_0257057509_row2061284104720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p126571746479">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_0016__en-us_topic_0257057509_p20658174134717">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p165919454710">Whether trace files are encrypted during transfer to an OBS bucket. This parameter must be used with <strong id="cts_api_0016__en-us_topic_0257057509_b64429161105737">kms_id</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row116121044472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p1666013414720">kms_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p18661174164719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p1266254154716">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_0016__en-us_topic_0257057509_b32773483733324">is_support_trace_files_encryption</strong> is set to <strong id="cts_api_0016__en-us_topic_0257057509_b185199293633324">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row1061217420474"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p196631424719">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p166641945472">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p18665249471">Unique ID of a log group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row17612949472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p18666443478">stream_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p666716484713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p16683494718">Unique ID of a log stream.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row10613943472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p106699416474">lts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p1867011464716"><a href="#cts_api_0016__en-us_topic_0257057509_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_0016__en-us_topic_0257057509_p56711454715">Trace analysis.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row12613941478"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p167424124719">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_0016__en-us_topic_0257057509_p267594154716">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p4677114204711">Whether to enable trace file verification.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0016__en-us_topic_0257057509_response_Lts"></a><a name="en-us_topic_0257057509_response_Lts"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0016__en-us_topic_0257057509_response_Lts" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Lts</caption><thead align="left"><tr id="cts_api_0016__en-us_topic_0257057509_row1267812417473"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="cts_api_0016__en-us_topic_0257057509_p168224164718">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_0016__en-us_topic_0257057509_p1568414404713">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_0016__en-us_topic_0257057509_p186853419477">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0016__en-us_topic_0257057509_row067810444710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p26869416473">is_lts_enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p176878411478">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p10688448471">Whether the LTS search function is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row66789414471"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p76891942475">log_group_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p56901640474">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p10691124124712">Name of the log group that CTS creates in LTS.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row14678245477"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p4692124194712">log_topic_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p1869334114715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0016__en-us_topic_0257057509_p15694194104720">Name of the log topic that CTS creates in LTS.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0016__en-us_topic_0257057509_section166951743477"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="cts_api_0016__en-us_topic_0257057509_screen2697542479">GET https://{endpoint}/v1.0/{project_id}/tracker?tracker_name=system</pre>
|
|
</div>
|
|
<div class="section" id="cts_api_0016__en-us_topic_0257057509_section4698948479"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0016__en-us_topic_0257057509_p769912414476"><strong id="cts_api_0016__en-us_topic_0257057509_b39800605105211">Status code: 200</strong></p>
|
|
<p id="cts_api_0016__en-us_topic_0257057509_p1070010418471">The request is successfully sent.</p>
|
|
<pre class="screen" id="cts_api_0016__en-us_topic_0257057509_screen970316424714">{
|
|
"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",
|
|
"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_0016__en-us_topic_0257057509_section27211949477"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0016__en-us_topic_0257057509_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_0016__en-us_topic_0257057509_row1372211494711"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cts_api_0016__en-us_topic_0257057509_p0724544476">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_0016__en-us_topic_0257057509_p4725164184714">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0016__en-us_topic_0257057509_row872214484719"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p47271042477">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p1172910434711">The request is successfully sent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row15723104184710"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p77301244478">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p127312416475">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row157235494710"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p1273218414718">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p47337420475">The request is rejected due to authentication failure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row872310416474"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p19735154144718">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p13736134184720">The server understood the request but refused to authorize it.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0016__en-us_topic_0257057509_row0723164114715"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0016__en-us_topic_0257057509_p8737848470">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0016__en-us_topic_0257057509_p12738045477">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0016__en-us_topic_0257057509_section973984134714"><h4 class="sectiontitle">Error Codes</h4><p id="cts_api_0016__en-us_topic_0257057509_p97403414716">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>
|
|
|