doc-exports/docs/lts/api-ref/lts_02_0008.html
Hasko, Vladimir 255730fbf9 lts_api (recreate of #279)
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2022-12-02 09:17:17 +00:00

114 lines
8.1 KiB
HTML

<a name="lts_02_0008"></a><a name="lts_02_0008"></a>
<h1 class="topictitle1">Querying a Log Stream</h1>
<div id="body1553917266016"><div class="section" id="lts_02_0008__section13262100202410"><h4 class="sectiontitle">Function</h4><p id="lts_02_0008__p105491350202715">This function describes how to query a log stream you have created to obtain its name, ID, expiration time, and creation time.</p>
</div>
<div class="section" id="lts_02_0008__section31681806"><h4 class="sectiontitle">URI</h4><ul id="lts_02_0008__ul165395536212"><li id="lts_02_0008__li5269929173052">URI format<p id="lts_02_0008__p51001235194218"><a name="lts_02_0008__li5269929173052"></a><a name="li5269929173052"></a>GET /v2.0/{project_id}/log-groups/{group_id}/log-topics/{topic_id}</p>
</li></ul>
<ul id="lts_02_0008__ul0109191102213"><li class="msonormal" id="lts_02_0008__li21091415229">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_02_0008__table805068" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="lts_02_0008__row57933110"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="lts_02_0008__p39489582428"><strong id="lts_02_0008__b12403115915814">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="lts_02_0008__p394816582427"><strong id="lts_02_0008__b204011214911">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="lts_02_0008__p1494835804214"><strong id="lts_02_0008__b1037483398">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="lts_02_0008__p5948158184213"><strong id="lts_02_0008__b12371341915">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="lts_02_0008__row19139995"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="lts_02_0008__p12949115814421">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="lts_02_0008__p2949195894219">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="lts_02_0008__p294911584424">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="lts_02_0008__p129498583422">Project ID</p>
</td>
</tr>
<tr id="lts_02_0008__row8975271"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="lts_02_0008__p1294955816424">group_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="lts_02_0008__p1794916588423">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="lts_02_0008__p1394955813422">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="lts_02_0008__p4949155824210">Log group ID</p>
</td>
</tr>
<tr id="lts_02_0008__row19973124944214"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="lts_02_0008__p1949458144212">topic_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="lts_02_0008__p20949125820420">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="lts_02_0008__p159491458124217">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="lts_02_0008__p1394955864216">ID of a log stream</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="lts_02_0008__section16700806"><h4 class="sectiontitle">Request</h4><ul id="lts_02_0008__ul39745794"><li id="lts_02_0008__li22167833">Request parameters<p id="lts_02_0008__p65292777"><a name="lts_02_0008__li22167833"></a><a name="li22167833"></a>None</p>
</li><li id="lts_02_0008__li50764081">Example request<pre class="screen" id="lts_02_0008__screen54223547">GET /v2.0/{project_id}/log-groups/{group_id}/log-topics/{topic_id}</pre>
</li></ul>
</div>
<div class="section" id="lts_02_0008__section16089528"><h4 class="sectiontitle">Response</h4><ul id="lts_02_0008__ul30031202"><li id="lts_02_0008__li1845369">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_02_0008__table894955330" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="lts_02_0008__row396125513310"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="lts_02_0008__p10735906504"><strong id="lts_02_0008__b1689691817108">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="lts_02_0008__p107353013504"><strong id="lts_02_0008__b1724720217107">Sub-Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="lts_02_0008__p273530165013"><strong id="lts_02_0008__b12145023131013">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="lts_02_0008__p137351504505"><strong id="lts_02_0008__b313592471017">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="lts_02_0008__row4961055739"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="lts_02_0008__p165468114508">log_topic_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="lts_02_0008__p19546911175015">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="lts_02_0008__p55461211165011">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="lts_02_0008__p15546171114507">Log stream name</p>
</td>
</tr>
<tr id="lts_02_0008__row1296185518312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="lts_02_0008__p454691175011">creation_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="lts_02_0008__p454611125019">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="lts_02_0008__p0546171111508">Int64</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="lts_02_0008__p155465118505">Log group creation time</p>
</td>
</tr>
<tr id="lts_02_0008__row669372916492"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="lts_02_0008__p054681125013">index_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="lts_02_0008__p125461811185017">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="lts_02_0008__p454611117504">Bool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="lts_02_0008__p5546181175014">Search switch</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="lts_02_0008__li15257210">Example response<pre class="screen" id="lts_02_0008__screen24255300">{
"log_topic_name": "lts-topic-jgpv",
"creation_time": 1550803822973,
"index_enabled": true
}</pre>
</li></ul>
</div>
<div class="section" id="lts_02_0008__section10588031"><h4 class="sectiontitle">Returned Value</h4><ul id="lts_02_0008__ul49543907"><li id="lts_02_0008__li43241981">Normal<p id="lts_02_0008__p9107452449"><a name="lts_02_0008__li43241981"></a><a name="li43241981"></a>200</p>
</li><li id="lts_02_0008__li44860134">Abnormal<p id="lts_02_0008__p8911139194318"><a name="lts_02_0008__li44860134"></a><a name="li44860134"></a>For details, see <a href="lts_02_0020.html">Status Code</a>.</p>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="lts_02_0006.html">Log Stream Management (Old Version)</a></div>
</div>
</div>