forked from docs/doc-exports
liusiying77
fdbbe7547a
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: liusiying77 <liusiying@huawei.com> Co-committed-by: liusiying77 <liusiying@huawei.com>
907 lines
41 KiB
HTML
907 lines
41 KiB
HTML
<a name="ListLogs"></a><a name="ListLogs"></a>
|
|
|
|
<h1 class="topictitle1">Querying Logs</h1>
|
|
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query logs in a specified log stream.</p>
|
|
</div>
|
|
<div class="section" id="ListLogs__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID. For details about how to obtain a project ID, see <a href="lts_api_0006.html">Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID</a>.</p>
|
|
<p>Minimum: <strong>32</strong></p>
|
|
<p>Maximum: <strong>32</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>log_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Log group ID. For details about how to obtain a log group ID, see <a href="lts_api_0006.html">Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID</a>.</p>
|
|
<p>Minimum: <strong>36</strong></p>
|
|
<p>Maximum: <strong>36</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>log_stream_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Log stream ID. For details about how to obtain a log stream ID, see <a href="lts_api_0006.html">Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID</a>.</p>
|
|
<p>Minimum: <strong>36</strong></p>
|
|
<p>Maximum: <strong>36</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLogs__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token obtained from IAM. For details about how to obtain a user token, see <a href="lts_api_0004.html">Obtaining a User Token</a>.</p>
|
|
<p>Minimum: <strong>1000</strong></p>
|
|
<p>Maximum: <strong>2000</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Set this parameter to application/json;charset=UTF-8.</p>
|
|
<p>Minimum: <strong>30</strong></p>
|
|
<p>Maximum: <strong>30</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLogs__request_ListLogsRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>UTC start time of the search window (in milliseconds).</p>
|
|
<div class="note"><span class="notetitle"> NOTE: </span><div class="notebody"><p>Maximum query time range: 180 days</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>UTC end time of the search window (in milliseconds).</p>
|
|
<div class="note"><span class="notetitle"> NOTE: </span><div class="notebody"><p>Maximum query time range: 180 days</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>labels</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Map<String,String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Filter criteria, which vary between log sources.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>keywords</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Keyword used for log search. A keyword is a word between two adjacent delimiters, for example, error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>line_num</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Sequence number of a log event. This parameter is not required for the first query, but is required for subsequent pagination queries. The value can be obtained from the response of the last query. The value of <strong>line_num</strong> should be between the values of <strong>start_time</strong> and <strong>end_time</strong>. If the custom time function is enabled, you need to use both this field and the <strong><strong>time</strong></strong> field to perform pagination query.</p>
|
|
<p>Minimum: <strong>19</strong></p>
|
|
<p>Maximum: <strong>19</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>__time__</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>If the custom time function is enabled, use both this field and the <strong>line_num</strong> field for pagination queries. The parameter values can be obtained from the returned information of the last query.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>is_desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Whether the search order is descending. The default value is <strong>false</strong> (ascending). You can also set the value to <strong>true</strong> (descending).</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>search_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>The value is <strong>init</strong> (default value) for the first query, or <strong>forwards</strong> or <strong>backwards</strong> for a pagination query. This parameter is used together with <strong>is_desc</strong> for pagination queries.The value can be <strong>forwards</strong> or <strong>backwards</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Number of logs to be queried each time. The value is <strong>50</strong> when this parameter is not set. You are advised to set this parameter to <strong>100</strong>.</p>
|
|
<p>Minimum: <strong>1</strong></p>
|
|
<p>Maximum: <strong>5000</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>highlight</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Whether the keyword is highlighted. The default value is <strong>true</strong> (highlighted). You can also set the value to <strong>false</strong> (not highlighted).</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>is_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Whether the number of log events is counted. The default value is <strong>false</strong> (not counted). You can also set the value to <strong>true</strong> (counted).</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>is_iterative</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Whether the log query is iterative. The default value is <strong>false</strong> (not iterative). You can also set the value to <strong>true</strong> (iterative).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLogs__response_ListLogsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>logs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ListLogs__response_LogContents">LogContents</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>Log information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>Number of logs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>isQueryComplete</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>Indicates whether the query is complete.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListLogs__response_LogContents"></a><a name="response_LogContents"></a><table cellpadding="4" cellspacing="0" summary="" id="ListLogs__response_LogContents" frame="border" border="1" rules="all"><caption><b>Table 5 </b>LogContents</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>content</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Raw log data.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>line_num</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Sequence number of a log line.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>labels</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>Map<String,String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Labels contained in a log event. The labels vary depending on log events.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p><strong>Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLogs__response_LogGroupErrorResultInfo400" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p>error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p>Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p>error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p>Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p><strong>Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLogs__response_LogGroupErrorResultInfo400_1" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p>error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p>Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p>error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p>Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p><strong>Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLogs__response_LogGroupErrorResultInfo400_2" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p>error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p>Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p>error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p>Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p><strong>Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLogs__response_LogGroupErrorResultInfo400_3" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p>error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p>Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p>error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p>Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Requests</h4><ul><li><p>Querying logs</p>
|
|
<pre class="screen">POST https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query
|
|
|
|
{
|
|
"start_time" : 1595659200000,
|
|
"end_time" : 1595659500000,
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest"
|
|
},
|
|
"keywords" : "log",
|
|
"limit" : 10,
|
|
"is_count" : true
|
|
}</pre>
|
|
</li><li><p>Querying logs for the first time</p>
|
|
<pre class="screen">POST v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query
|
|
|
|
{
|
|
"start_time" : 1595659200000,
|
|
"end_time" : 1595659500000,
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest"
|
|
},
|
|
"keywords" : "log",
|
|
"line_num" : "1595659490239433658",
|
|
"is_desc" : "false",
|
|
"search_type" : "forwards",
|
|
"limit" : "3",
|
|
"is_count" : true
|
|
}</pre>
|
|
</li><li><p>For a pagination query (Assume that the search starts from the log event containing <strong>NO 5</strong>. Log events containing <strong>NO 6</strong>, <strong>NO 7</strong>, and <strong>NO 8</strong> are the target log events):</p>
|
|
<pre class="screen">POST v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query '
|
|
|
|
{
|
|
"start_time" : 1595659200000,
|
|
"end_time" : 1595659500000,
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest"
|
|
},
|
|
"keywords" : "log",
|
|
"line_num" : "1595659490239433658",
|
|
"is_desc" : "true",
|
|
"search_type" : "backwards",
|
|
"limit" : "3",
|
|
"is_count" : true
|
|
}</pre>
|
|
</li><li><p>For a pagination query (Assume that the search starts from the log event containing <strong>NO 5</strong>. Log events containing <strong>NO 8</strong>, <strong>NO 7</strong>, and <strong>NO 6</strong> are the target log events):</p>
|
|
<pre class="screen">POST v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query
|
|
|
|
{
|
|
"start_time" : 1595659200000,
|
|
"end_time" : 1595659500000,
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest"
|
|
},
|
|
"keywords" : "log",
|
|
"line_num" : "1595659490239433658",
|
|
"is_desc" : "false",
|
|
"search_type" : "backwards",
|
|
"limit" : "3",
|
|
"is_count" : true
|
|
}</pre>
|
|
</li><li><p>For a pagination query (Assume that the search starts from the log event containing <strong>NO 5</strong>. Log events containing <strong>NO 2</strong>, <strong>NO 3</strong>, and <strong>NO 4</strong> are the target log events):</p>
|
|
<pre class="screen">POST v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query '
|
|
|
|
{
|
|
"start_time" : 1595659200000,
|
|
"end_time" : 1595659500000,
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest"
|
|
},
|
|
"keywords" : "log",
|
|
"line_num" : "1595659490239433658",
|
|
"is_desc" : "true",
|
|
"search_type" : "forwards",
|
|
"limit" : "3",
|
|
"is_count" : true
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
|
<p>The request is successful.</p>
|
|
<ul><li><p>Querying logs for the first time</p>
|
|
<pre class="screen">{
|
|
"count" : 32,
|
|
"logs" : [ {
|
|
"content" : "2020-07-25/14:44:42 this <HighLightTag>log</HighLightTag> is Error NO 1",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433654"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:43 this <HighLightTag>log</HighLightTag> is Error NO 2",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433655"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:44 this <HighLightTag>log</HighLightTag> is Error NO 3",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433656"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:45 this <HighLightTag>log</HighLightTag> is Error NO 4",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433657"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:46 this <HighLightTag>log</HighLightTag> is Error NO 5",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433658"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:47 this <HighLightTag>log</HighLightTag> is Error NO 6",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433659"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:48 this <HighLightTag>log</HighLightTag> is Error NO 7",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433660"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:49 this <HighLightTag>log</HighLightTag> is Error NO 8",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433661"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:50 this <HighLightTag>log</HighLightTag> is Error NO 9",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490839420574"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:51 this <HighLightTag>log</HighLightTag> is Error NO 10",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659491839412667"
|
|
} ]
|
|
}</pre>
|
|
</li><li><p>For a pagination query (Assume that the search starts from the log event containing <strong>NO 5</strong>. Log events containing <strong>NO 6</strong>, <strong>NO 7</strong>, and <strong>NO 8</strong> are the target log events):</p>
|
|
<pre class="screen">{
|
|
"count" : 32,
|
|
"logs" : [ {
|
|
"content" : "2020-07-25/14:44:47 this <HighLightTag>log</HighLightTag> is Error NO 6",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433659"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:48 this <HighLightTag>log</HighLightTag> is Error NO 7",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433660"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:49 this <HighLightTag>log</HighLightTag> is Error NO 8",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433661"
|
|
} ]
|
|
}</pre>
|
|
</li><li><p>For a pagination query (Assume that the search starts from the log event containing <strong>NO 5</strong>. Log events containing <strong>NO 8</strong>, <strong>NO 7</strong>, and <strong>NO 6</strong> are the target log events):</p>
|
|
<pre class="screen">{
|
|
"count" : 32,
|
|
"logs" : [ {
|
|
"content" : "2020-07-25/14:44:49 this <HighLightTag>log</HighLightTag> is Error NO 8",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433661"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:48 this <HighLightTag>log</HighLightTag> is Error NO 7",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433660"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:47 this <HighLightTag>log</HighLightTag> is Error NO 6",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433659"
|
|
} ]
|
|
}</pre>
|
|
</li><li><p>For a pagination query (Assume that the search starts from the log event containing <strong>NO 5</strong>. Log events containing <strong>NO 2</strong>, <strong>NO 3</strong>, and <strong>NO 4</strong> are the target log events):</p>
|
|
<pre class="screen">{
|
|
"count" : 32,
|
|
"logs" : [ {
|
|
"content" : "2020-07-25/14:44:43 this <HighLightTag>log</HighLightTag> is Error NO 2",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433655"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:44 this <HighLightTag>log</HighLightTag> is Error NO 3",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433656"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:45 this <HighLightTag>log</HighLightTag> is Error NO 4",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433657"
|
|
} ]
|
|
}</pre>
|
|
</li><li><p>For a pagination query (Assume that the search starts from the log event containing <strong>NO 5</strong>. Log events containing <strong>NO 4</strong>, <strong>NO 3</strong>, and <strong>NO 2</strong> are the target log events):</p>
|
|
<pre class="screen">{
|
|
"count" : 32,
|
|
"logs" : [ {
|
|
"content" : "2020-07-25/14:44:45 this <HighLightTag>log</HighLightTag> is Error NO 4",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433657"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:44 this <HighLightTag>log</HighLightTag> is Error NO 3",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433656"
|
|
}, {
|
|
"content" : "2020-07-25/14:44:43 this <HighLightTag>log</HighLightTag> is Error NO 2",
|
|
"labels" : {
|
|
"hostName" : "ecs-kwxtest",
|
|
"hostIP" : "192.168.0.156",
|
|
"appName" : "default_appname",
|
|
"containerName" : "CONFIG_FILE",
|
|
"clusterName" : "CONFIG_FILE",
|
|
"hostId" : "9787ef31-fd7b-4eff-ba71-72d580f11f55",
|
|
"podName" : "default_procname",
|
|
"clusterId" : "CONFIG_FILE",
|
|
"nameSpace" : "CONFIG_FILE",
|
|
"category" : "LTS"
|
|
},
|
|
"line_num" : "1595659490239433655"
|
|
} ]
|
|
}</pre>
|
|
</li></ul>
|
|
<p><strong>Status code: 400</strong></p>
|
|
<p>Bad request. The request is invalid or the query statement is incorrect. Modify the request based on the description in <strong>error_msg</strong> before a retry.</p>
|
|
<pre class="screen">{
|
|
"error_code" : "LTS.0009",
|
|
"error_msg" : "Failed to validate the request body"
|
|
}</pre>
|
|
<p><strong>Status code: 401</strong></p>
|
|
<p>AuthFailed. Authentication failed. Check the token and try again.</p>
|
|
<pre class="screen">{
|
|
"error_code" : "LTS.0003",
|
|
"error_msg" : "Invalid token"
|
|
}</pre>
|
|
<p><strong>Status code: 403</strong></p>
|
|
<p>Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.</p>
|
|
<pre class="screen">{
|
|
"error_code" : "LTS.0001",
|
|
"error_msg" : "Invalid projectId"
|
|
}</pre>
|
|
<p><strong>Status code: 500</strong></p>
|
|
<p>InternalServerError.</p>
|
|
<p>The server has received the request but encountered an internal error.</p>
|
|
<pre class="screen">{
|
|
"error_code" : "LTS.0202",
|
|
"error_msg" : "Failed to query lts log"
|
|
}</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLogs__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Bad request. The request is invalid or the query statement is incorrect. Modify the request based on the description in <strong>error_msg</strong> before a retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>AuthFailed. Authentication failed. Check the token and try again.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>InternalServerError.</p>
|
|
<p>The server has received the request but encountered an internal error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Log Management</a></div>
|
|
</div>
|
|
</div>
|
|
|