forked from docs/doc-exports
Li, Qiao
914011d51b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
155 lines
11 KiB
HTML
155 lines
11 KiB
HTML
<a name="waf_02_0078"></a><a name="waf_02_0078"></a>
|
|
|
|
<h1 class="topictitle1">Querying the List of Event Log Files</h1>
|
|
<div id="body1547630162244"><div class="section" id="waf_02_0078__section32792555"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0078__p8416265">This API is used to query the list of event log files.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0078__section26697540"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0078__ul10628851"><li id="waf_02_0078__li28550801">URI format<p id="waf_02_0078__p55630622"><a name="waf_02_0078__li28550801"></a><a name="li28550801"></a>GET /v1/{project_id}/waf/event/dump?offset={offset}&limit={limit}</p>
|
|
</li><li id="waf_02_0078__li30913555">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0078__table9786546" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0078__row45293161"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="waf_02_0078__p44867418"><strong id="waf_02_0078__b8938194854910">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="waf_02_0078__p10382207"><strong id="waf_02_0078__b19189950184911">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="waf_02_0078__p35652416"><strong id="waf_02_0078__b126918515499">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="waf_02_0078__p2164615"><strong id="waf_02_0078__b6172165394911">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0078__row41116089"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0078__p42068928">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0078__p52140036">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0078__p62593388">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0078__p36899681">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0078__row30072732"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0078__p19972195">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0078__p7135119">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0078__p41073800">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0078__p21617533">Specifies the number of returned pages. Its value ranges from <strong id="waf_02_0078__b62414315508">0</strong> to <strong id="waf_02_0078__b324113315501">65535</strong>. The default value is <strong id="waf_02_0078__b182411320504">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0078__row12247267"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0078__p52504570">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0078__p25011769">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0078__p12687433">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0078__p25357967">Specifies the maximum number of records displayed on each page. Its value ranges from <strong id="waf_02_0078__b152329814504">0</strong> to <strong id="waf_02_0078__b023914820508">50</strong>. The default value is <strong id="waf_02_0078__b62395817507">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0078__section38951274"><h4 class="sectiontitle">Request</h4><p id="waf_02_0078__p2355343437">Request parameters</p>
|
|
<p class="msonormal" id="waf_02_0078__p27261179">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0078__section15017149"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0078__p13110174504313">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0078__table15472974" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0078__row56736167"><th align="left" class="cellrowborder" valign="top" width="30.316968303169677%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0078__p32226778"><strong id="waf_02_0078__b959141617504">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.88701129887011%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0078__p60232263"><strong id="waf_02_0078__b1118551765017">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0078__p46975124"><strong id="waf_02_0078__b1212971885018">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0078__row20122934"><td class="cellrowborder" valign="top" width="30.316968303169677%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0078__p19344951">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.88701129887011%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0078__p23437164">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0078__p19362109">Specifies the total number of log files.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0078__row40041260"><td class="cellrowborder" valign="top" width="30.316968303169677%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0078__p22116660">items</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.88701129887011%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0078__p46619020"><a href="#waf_02_0078__table16394183011019">Table 3</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0078__p1603648">Specifies the log file objects.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0078__table16394183011019"></a><a name="table16394183011019"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0078__table16394183011019" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="waf_02_0078__b1547212540355">items</strong></caption><thead align="left"><tr id="waf_02_0078__row939613301015"><th align="left" class="cellrowborder" valign="top" width="30.936906309369068%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0078__p039873016013"><strong id="waf_02_0078__b1684465411526">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.727127287271276%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0078__p183997301406"><strong id="waf_02_0078__b752445610526">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.33596640335966%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0078__p839973013010"><strong id="waf_02_0078__b1648525735216">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0078__row6254134620148"><td class="cellrowborder" valign="top" width="30.936906309369068%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0078__p15927154410145">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.727127287271276%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0078__p18929194417149">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.33596640335966%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0078__p8930944171414">Specifies the ID of a log file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0078__row9253144691412"><td class="cellrowborder" valign="top" width="30.936906309369068%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0078__p1493184451410">filename</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.727127287271276%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0078__p17933114491410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.33596640335966%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0078__p15934444201410">Specifies the name of a log file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0078__row325324620149"><td class="cellrowborder" valign="top" width="30.936906309369068%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0078__p7481196132815">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.727127287271276%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0078__p1960181082811">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.33596640335966%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0078__p169381144191419">Specifies the total number of events in a log file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0078__row8253104617149"><td class="cellrowborder" valign="top" width="30.936906309369068%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0078__p139407442141">url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.727127287271276%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0078__p1494224410148">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.33596640335966%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0078__p1454465813112">Specifies the URL to download a log file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0078__row2025284612149"><td class="cellrowborder" valign="top" width="30.936906309369068%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0078__p17943164411414">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.727127287271276%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0078__p169441144111414">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.33596640335966%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0078__p199461944101413">Specifies the time when a log file is generated.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0078__section1014014529435"><h4 class="sectiontitle">Example</h4><p id="waf_02_0078__p131114469537"><strong id="waf_02_0078__b565614189567">total</strong> with a value of <strong id="waf_02_0078__b18656518125612">2</strong> is used as an example.</p>
|
|
<div class="p" id="waf_02_0078__p2097713194413">Response example<pre class="screen" id="waf_02_0078__screen1915819528435">{
|
|
"total": 2,
|
|
"items": [{
|
|
"id": "3a9b5c0f96784ec8abd8ba61a98064ef",
|
|
"filename": "WAF-eu-de-2019-01-15.csv",
|
|
"total": "100",
|
|
"url": "https://obs_server/obs-waf-log/WAF-eu-de-2019-01-15-xxxxxxxxxx.csv?AWSAccessKeyId=XXXXXXXXXXXX&Expires=1547632&Signature=nC7ipaGzLQs",
|
|
"timestamp": 1499817600
|
|
}, {
|
|
"id": "44d887434169475794b2717438f7fa78",
|
|
"filename": "WAF-eu-deW-2019-01-14.csv",
|
|
"total": "200",
|
|
"url": "https://obs_server/obs-waf-log/WAF-eu-de-2019-01-14-xxxxxxxxxx.csv?AWSAccessKeyId=XXXXXXXXXXXX&Expires=1547632&Signature=nC7ipaGzLQs",
|
|
"timestamp": 1499817601
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="waf_02_0069.html">Event Logs</a></div>
|
|
</div>
|
|
</div>
|
|
|