doc-exports/docs/lts/api-ref/lts_02_0004.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

115 lines
8.1 KiB
HTML

<a name="lts_02_0004"></a><a name="lts_02_0004"></a>
<h1 class="topictitle1">Querying a Log Group</h1>
<div id="body1553912598337"><div class="section" id="lts_02_0004__section13262100202410"><h4 class="sectiontitle">Function</h4><p id="lts_02_0004__p105491350202715">This function describes how to query a log group you have created to obtain its name, ID, expiration time, and creation time.</p>
</div>
<div class="section" id="lts_02_0004__section31681806"><h4 class="sectiontitle">URI</h4><ul id="lts_02_0004__ul165395536212"><li id="lts_02_0004__li5269929173052">URI format<p id="lts_02_0004__p8388162315813"><a name="lts_02_0004__li5269929173052"></a><a name="li5269929173052"></a>GET /v2.0/{project_id}/log-groups/{group_id}</p>
</li></ul>
<ul id="lts_02_0004__ul0109191102213"><li class="msonormal" id="lts_02_0004__li21091415229">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_02_0004__table805068" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="lts_02_0004__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_0004__p62070358"><strong id="lts_02_0004__b128317754613">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_0004__p61643119"><strong id="lts_02_0004__b1819188124617">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_0004__p27036712"><strong id="lts_02_0004__b12937918465">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_0004__p42490025"><strong id="lts_02_0004__b82209541461">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="lts_02_0004__row19139995"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="lts_02_0004__p166901052205610">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_0004__p13690175218569">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_0004__p1690852165618">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_0004__p106901852145617">Project ID</p>
</td>
</tr>
<tr id="lts_02_0004__row8975271"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="lts_02_0004__p1169065215561">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_0004__p969016528569">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_0004__p969011527564">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_0004__p186901852125613">Log group ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="lts_02_0004__section16700806"><h4 class="sectiontitle">Request</h4><ul id="lts_02_0004__ul39745794"><li id="lts_02_0004__li22167833">Request parameters<p id="lts_02_0004__p65292777"><a name="lts_02_0004__li22167833"></a><a name="li22167833"></a>None</p>
</li><li id="lts_02_0004__li50764081">Example request<pre class="screen" id="lts_02_0004__screen54223547">GET /v2.0/{project_id}/log-groups/{group_id}</pre>
</li></ul>
</div>
<div class="section" id="lts_02_0004__section16089528"><h4 class="sectiontitle">Response</h4><ul id="lts_02_0004__ul30031202"><li id="lts_02_0004__li1845369">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_02_0004__table894955330" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="lts_02_0004__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_0004__p29326511412"><strong id="lts_02_0004__b1124318619407">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_0004__p293213519412"><strong id="lts_02_0004__afd1c772bc0d34dd0954eb451c30339a1">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_0004__p1693275249"><strong id="lts_02_0004__b44001144134514">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_0004__p79321055418"><strong id="lts_02_0004__b9717144524512">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="lts_02_0004__row14961155834"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="lts_02_0004__p3933557412">log_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="lts_02_0004__p393310520420">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="lts_02_0004__p6933955419">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_0004__p1393365243">Log group ID</p>
</td>
</tr>
<tr id="lts_02_0004__row2961555431"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="lts_02_0004__p1893314511413">log_group_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_0004__p9933185745">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="lts_02_0004__p19933115241">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_0004__p39331751246">Log group name</p>
</td>
</tr>
<tr id="lts_02_0004__row4961055739"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="lts_02_0004__p0933954411">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_0004__p10933751845">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="lts_02_0004__p11933251149">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_0004__p13933152045">Log group creation time</p>
</td>
</tr>
<tr id="lts_02_0004__row1296185518312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="lts_02_0004__p39331057410">ttl_in_days</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="lts_02_0004__p16933165844">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="lts_02_0004__p1993320514419">Int</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="lts_02_0004__p5933125343">Log expiration time</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="lts_02_0004__li15257210">Example response<pre class="screen" id="lts_02_0004__screen24255300">{
"log_group_id": "8ac95c07-357b-11e9-bc2a-286ed488ce71",
"log_group_name": "lts-group-3h0y",
"creation_time": 1550714033721,
"ttl_in_days": 7
} </pre>
</li></ul>
</div>
<div class="section" id="lts_02_0004__section10588031"><h4 class="sectiontitle">Returned Value</h4><ul id="lts_02_0004__ul49543907"><li id="lts_02_0004__li43241981">Normal<p id="lts_02_0004__p9107452449"><a name="lts_02_0004__li43241981"></a><a name="li43241981"></a>200</p>
</li><li id="lts_02_0004__li44860134">Abnormal<p id="lts_02_0004__p8911139194318"><a name="lts_02_0004__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_0002.html">Log Group Management (Old Version)</a></div>
</div>
</div>