yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
9776db0ee8a683d760113bf6d389063073121b5d
doc-exports/docs/cfw/api-ref/ListFlowLogs.html
qiaoli 9776db0ee8 First version of the CFW API 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiaoli <qiaoli@huawei.com>
Co-committed-by: qiaoli <qiaoli@huawei.com>
2025-01-21 07:59:01 +00:00

643 lines
46 KiB
HTML
Raw Blame History

<a name="ListFlowLogs"></a><a name="ListFlowLogs"></a>
<h1 class="topictitle1">Querying Flow Logs</h1>
<div id="body1708331107508"><div class="section" id="ListFlowLogs__section9190182410330"><h4 class="sectiontitle">Function</h4><p id="ListFlowLogs__p2191102413318">This API is used to query flow logs.</p>
</div>
<div class="section" id="ListFlowLogs__section81911224153312"><h4 class="sectiontitle">URI</h4><p id="ListFlowLogs__p419117248337">GET /v1/{project_id}/cfw/logs/flow</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFlowLogs__table16192182453313" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListFlowLogs__row1519282418335"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListFlowLogs__p10192122433314">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListFlowLogs__p121921524163316">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListFlowLogs__p17192112433310">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListFlowLogs__p1819382411332">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFlowLogs__row11192524143311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListFlowLogs__p719319245332">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListFlowLogs__p3193162416339">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListFlowLogs__p4193424183315">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListFlowLogs__p181931245330">Project ID, which can be obtained by calling an API or from the console. For details, see <a href="cfw_02_0015.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFlowLogs__table9196182473318" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListFlowLogs__row20194524133315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListFlowLogs__p11196024143319">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListFlowLogs__p14197424153319">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListFlowLogs__p101971024173313">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListFlowLogs__p2197102463310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFlowLogs__row1019422416337"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p5197102483313">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p31981324143311">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p1319832412334">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p10198122443315">Firewall ID, which can be obtained by referring to <a href="cfw_02_0028.html">Obtaining a Firewall ID</a>.</p>
</td>
</tr>
<tr id="ListFlowLogs__row119462463315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p2019814243332">direction</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p21981524183318">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p219882415338">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p61991824173317">Direction. Its value can be <strong id="ListFlowLogs__b13199024163315">in2out</strong> or <strong id="ListFlowLogs__b519922414337">out2in</strong>.</p>
</td>
</tr>
<tr id="ListFlowLogs__row10194202418339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p1919932415335">log_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p519910242334">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p61995240334">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p92001324143319">Log type. Its value can be <strong id="ListFlowLogs__b17200024183315">internet</strong>, <strong id="ListFlowLogs__b17200524193312">vpc</strong>, or <strong id="ListFlowLogs__b420011245339">nat</strong>.</p>
</td>
</tr>
<tr id="ListFlowLogs__row19194424163312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p1200824103317">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p5200724153312">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p122002245338">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p13200324103316">Start time, in milliseconds. The value is a timestamp, for example, 1718936272648.</p>
</td>
</tr>
<tr id="ListFlowLogs__row51941242331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p2200324133320">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p1020114245338">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p12016243330">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p132011124123311">End time, in milliseconds. The value is a timestamp, for example, 1718936272648.</p>
</td>
</tr>
<tr id="ListFlowLogs__row61941724123311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p620117244332">src_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p12201102493310">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p12010240330">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p120212245336">Source IP address.</p>
</td>
</tr>
<tr id="ListFlowLogs__row191942024183319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p3202224113319">src_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p11202182419338">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p13202152423311">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p72021024173311">Source port.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1019516245330"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p13202102419336">dst_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p12031724183313">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p1020342433313">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p120312245335">Destination IP address.</p>
</td>
</tr>
<tr id="ListFlowLogs__row15195224163319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p12203122419337">dst_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p520317247334">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p1120317244334">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p12203152473312">Destination port.</p>
</td>
</tr>
<tr id="ListFlowLogs__row919511249339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p11204162443311">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p9204924133312">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p12204182417335">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p1120411241333">Protocol type. Its value can be <strong id="ListFlowLogs__b20204182415335">TCP</strong>, <strong id="ListFlowLogs__b15204824143314">UDP</strong>, <strong id="ListFlowLogs__b1320412243335">ICMP</strong>, or <strong id="ListFlowLogs__b142041024183314">ICMPv6</strong>.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1219542423316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p3204324143310">app</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p15205182416331">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p1320542416333">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p5205924133311">Rule application type. Its value can be <strong id="ListFlowLogs__b820662483316">HTTP</strong>, <strong id="ListFlowLogs__b820612443319">HTTPS</strong>, <strong id="ListFlowLogs__b1720602413333">TLS1</strong>, <strong id="ListFlowLogs__b1520622423312">DNS</strong>, <strong id="ListFlowLogs__b120602413334">SSH</strong>, <strong id="ListFlowLogs__b19206132416335">MYSQL</strong>, <strong id="ListFlowLogs__b42065244339">SMTP</strong>, <strong id="ListFlowLogs__b520618249336">RDP</strong>, <strong id="ListFlowLogs__b16206112412333">RDPS</strong>, <strong id="ListFlowLogs__b1620612453317">VNC</strong>, <strong id="ListFlowLogs__b1220610242333">POP3</strong>, <strong id="ListFlowLogs__b15206112413310">IMAP4</strong>, <strong id="ListFlowLogs__b2206824133315">SMTPS</strong>, <strong id="ListFlowLogs__b620602473312">POP3S</strong>, <strong id="ListFlowLogs__b520611242333">FTPS</strong>, <strong id="ListFlowLogs__b4206824113317">ANY</strong>, or <strong id="ListFlowLogs__b4206192483314">BGP</strong>.</p>
</td>
</tr>
<tr id="ListFlowLogs__row719513249330"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p720642411336">log_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p920672417334">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p82061024143310">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p32061324103313">Document ID. For the first page, its value is null. For other pages, its value can be the <strong id="ListFlowLogs__b1520612473316">log_id</strong> of the last record in the last query.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1919511247333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p120702414337">next_date</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p1920742423310">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p162072024123313">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p1920712241332">Next date. For the first page, its value is null. For other pages, its value can be the <strong id="ListFlowLogs__b420772417334">start_time</strong> of the last record in the last query.</p>
</td>
</tr>
<tr id="ListFlowLogs__row171951624103320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p152071424173315">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p22071124153313">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p0208122473313">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p172084249335">Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null.</p>
</td>
</tr>
<tr id="ListFlowLogs__row20195162413336"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p1120862473320">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p172081524163318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p172082024203310">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p2208172493313">Number of records displayed on each page. The value ranges from 1 to 1024.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1119542413339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p19208112443310">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p142099246332">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p152097246339">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p520922412337">Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to <a href="cfw_02_0027.html">Obtaining an Enterprise Project ID</a>. If the enterprise project function is not enabled, the value is <strong id="ListFlowLogs__b920992414333">0</strong>.</p>
</td>
</tr>
<tr id="ListFlowLogs__row21951324183310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p162091424183315">dst_host</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p9209182418337">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p122106243338">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p1321052417333">Destination host.</p>
</td>
</tr>
<tr id="ListFlowLogs__row119513245337"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p721072453314">src_region_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p621042453316">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p122101824173316">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p0210142493310">Source region name.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1195122412336"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p02111924153313">dst_region_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p221112443315">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p721122413311">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p22112244335">Destination region name.</p>
</td>
</tr>
<tr id="ListFlowLogs__row6195122412338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p2211162483315">src_province_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p13212424103315">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p82121424173313">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p14212924153314">Source province name.</p>
</td>
</tr>
<tr id="ListFlowLogs__row101951224143316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p16212112417337">dst_province_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p52122024103318">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p122121324153314">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p1221222414333">Destination province name.</p>
</td>
</tr>
<tr id="ListFlowLogs__row131958245339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p721392419336">src_city_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p521314245338">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p1721317246333">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p1821311244336">Source city name.</p>
</td>
</tr>
<tr id="ListFlowLogs__row191951524193313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFlowLogs__p6213192417332">dst_city_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFlowLogs__p2021372412333">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFlowLogs__p3214142493318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFlowLogs__p19214162443310">Destination city name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListFlowLogs__section921482443311"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFlowLogs__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListFlowLogs__row1321422411332"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListFlowLogs__p1121592483311">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListFlowLogs__p2215112412335">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListFlowLogs__p122151824183319">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListFlowLogs__p721542463316">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFlowLogs__row321412433314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListFlowLogs__p1021572423316">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListFlowLogs__p12216224113316">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListFlowLogs__p121602473312">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListFlowLogs__p152161724183317">User token. You can obtain the token by referring to <a href="cfw_02_0029.html">Obtaining a User Token</a>.</p>
</td>
</tr>
<tr id="ListFlowLogs__row6311134553310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListFlowLogs__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListFlowLogs__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListFlowLogs__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListFlowLogs__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListFlowLogs__section1521632418339"><h4 class="sectiontitle">Response Parameters</h4><p id="ListFlowLogs__p72168243335"><strong id="ListFlowLogs__b1821772493311">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFlowLogs__response_HttpQueryCfwFlowLogsResponseDTO" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListFlowLogs__row12217724173315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListFlowLogs__p17217324183315">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListFlowLogs__p13217152410336">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListFlowLogs__p121812249336">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFlowLogs__row15217142443317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListFlowLogs__p182181724113313">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListFlowLogs__p152181924193310"><a href="#ListFlowLogs__response_data">data</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListFlowLogs__p7218224163316">Return value for querying flow logs.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListFlowLogs__response_data"></a><a name="response_data"></a><table cellpadding="4" cellspacing="0" summary="" id="ListFlowLogs__response_data" frame="border" border="1" rules="all"><caption><b>Table 5 </b>data</caption><thead align="left"><tr id="ListFlowLogs__row2218124183311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListFlowLogs__p9219132443310">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListFlowLogs__p121911242331">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListFlowLogs__p521952410331">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFlowLogs__row132182244335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListFlowLogs__p821992483314">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListFlowLogs__p16220182483315">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListFlowLogs__p822020249334">Total number of returned records for querying flow logs.</p>
</td>
</tr>
<tr id="ListFlowLogs__row14219524123312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListFlowLogs__p1422032423315">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListFlowLogs__p14220142453312">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListFlowLogs__p322052413316">Number of records displayed on each page. The value ranges from 1 to 1024.</p>
</td>
</tr>
<tr id="ListFlowLogs__row52191924113316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListFlowLogs__p15220132414335">records</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListFlowLogs__p1522182403320">Array of <a href="#ListFlowLogs__response_records">records</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListFlowLogs__p3221112411336">Record.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListFlowLogs__response_records"></a><a name="response_records"></a><table cellpadding="4" cellspacing="0" summary="" id="ListFlowLogs__response_records" frame="border" border="1" rules="all"><caption><b>Table 6 </b>records</caption><thead align="left"><tr id="ListFlowLogs__row7221162423317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListFlowLogs__p82232024183315">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListFlowLogs__p6223324103318">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListFlowLogs__p4224224203319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFlowLogs__row1122282483319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p112241324193310">bytes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p322412417334">Double</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p19224124183314">Byte.</p>
</td>
</tr>
<tr id="ListFlowLogs__row42223245332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p122482418332">direction</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p192244247333">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p32251924113311">Direction: <strong id="ListFlowLogs__b4225224113317">in2out</strong> (outbound) or <strong id="ListFlowLogs__b82251424123316">out2in</strong> (inbound).</p>
</td>
</tr>
<tr id="ListFlowLogs__row722232403318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p9225424113320">packets</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p10225182493313">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p7225132493312">Number of packets.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1222262433312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p822612245331">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p2226224113313">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p162261524103317">Start time, in milliseconds. The value is a timestamp, for example, 1718936272648.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1622216245339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p102261624113313">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p15226122423318">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p13226122411339">End time, in milliseconds. The value is a timestamp, for example, 1718936272648.</p>
</td>
</tr>
<tr id="ListFlowLogs__row0222112410338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p182277249339">log_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p62271424173313">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p12227112410331">Document ID.</p>
</td>
</tr>
<tr id="ListFlowLogs__row92221624173320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p122712483318">src_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p192272024113315">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p82271824113320">Source IP address.</p>
</td>
</tr>
<tr id="ListFlowLogs__row102221424183314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p122282024103318">src_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p4228424143312">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p1522862403319">Source port.</p>
</td>
</tr>
<tr id="ListFlowLogs__row19222324143318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p10228924153318">dst_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p16228102416335">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p6228224123312">Destination IP address.</p>
</td>
</tr>
<tr id="ListFlowLogs__row222242413317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p18229122413336">app</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p9229172416334">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p3229524193315">Rule application type. Its value can be <strong id="ListFlowLogs__b17230172411334">HTTP</strong>, <strong id="ListFlowLogs__b623092423313">HTTPS</strong>, <strong id="ListFlowLogs__b723092483312">TLS1</strong>, <strong id="ListFlowLogs__b112304243331">DNS</strong>, <strong id="ListFlowLogs__b16230624113313">SSH</strong>, <strong id="ListFlowLogs__b1123082410339">MYSQL</strong>, <strong id="ListFlowLogs__b1423042416330">SMTP</strong>, <strong id="ListFlowLogs__b923013244336">RDP</strong>, <strong id="ListFlowLogs__b172301024103316">RDPS</strong>, <strong id="ListFlowLogs__b172301824203310">VNC</strong>, <strong id="ListFlowLogs__b1823042443314">POP3</strong>, <strong id="ListFlowLogs__b1523072473316">IMAP4</strong>, <strong id="ListFlowLogs__b10230102423312">SMTPS</strong>, <strong id="ListFlowLogs__b1423042413310">POP3S</strong>, <strong id="ListFlowLogs__b523012414338">FTPS</strong>, <strong id="ListFlowLogs__b0230142463316">ANY</strong>, or <strong id="ListFlowLogs__b18230112473319">BGP</strong>.</p>
</td>
</tr>
<tr id="ListFlowLogs__row172222024133310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p1123072433319">dst_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p10230152493318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p323013242339">Destination port.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1822222423315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p1323052463318">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p1423118244339">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p123112246333">Protocol type: <strong id="ListFlowLogs__b17231524113319">6</strong> (TCP), <strong id="ListFlowLogs__b1231182413310">17</strong> (UDP), <strong id="ListFlowLogs__b3231624203318">1</strong> (ICMP), <strong id="ListFlowLogs__b02317243336">58</strong> (ICMPv6), or <strong id="ListFlowLogs__b323122412333">-1</strong> (any). It cannot be left blank when <strong id="ListFlowLogs__b823114246336">type</strong> is set to <strong id="ListFlowLogs__b16231142463314">0</strong> (manual), and can be left blank when <strong id="ListFlowLogs__b16231112418330">type</strong> is set to <strong id="ListFlowLogs__b1923116242331">1</strong> (automatic).</p>
</td>
</tr>
<tr id="ListFlowLogs__row52221424183316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p123182415332">dst_host</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p1623211247331">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p8232102433319">Destination host.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1022242418333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p122327244330">dst_region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p202321024173316">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p02321624123320">Destination region ID.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1422282483319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p1123232433312">dst_region_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p1623319246338">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p142337249335">Destination region name.</p>
</td>
</tr>
<tr id="ListFlowLogs__row11222424173311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p1136122410331">src_region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p193613243331">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p8361152411331">Source region ID.</p>
</td>
</tr>
<tr id="ListFlowLogs__row42221024153316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p836111242333">src_region_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p736262414339">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p14362112411339">Source region name.</p>
</td>
</tr>
<tr id="ListFlowLogs__row17222924123315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p8362124123315">dst_province_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p136212413315">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p23621624203312">Destination province ID.</p>
</td>
</tr>
<tr id="ListFlowLogs__row2222224133310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p5362924173311">dst_province_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p14362112413319">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p1736214248337">Destination province name.</p>
</td>
</tr>
<tr id="ListFlowLogs__row5222182433313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p113621524143318">dst_city_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p11362172417336">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p936272410337">Destination city ID.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1222162420331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p1236262443320">dst_city_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p6362724153315">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p8362624133314">Destination city name.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1222824183317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p436202443316">src_province_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p03621024153319">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p5362132443312">Source province ID.</p>
</td>
</tr>
<tr id="ListFlowLogs__row3222024103310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p1362924193315">src_province_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p16362182415338">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p173638241337">Source province name.</p>
</td>
</tr>
<tr id="ListFlowLogs__row1222132483317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p6363724103311">src_city_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p336382414334">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p93631124113313">Source city ID.</p>
</td>
</tr>
<tr id="ListFlowLogs__row16222192414332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFlowLogs__p193631324143315">src_city_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFlowLogs__p63638249337">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFlowLogs__p636342463316">Source city name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListFlowLogs__p1436352413310"><strong id="ListFlowLogs__b5363324143318">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFlowLogs__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListFlowLogs__row22381324143314"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListFlowLogs__p11363724123312">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListFlowLogs__p103631424133312">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListFlowLogs__p636312241335">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFlowLogs__row0238172483310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListFlowLogs__p12363102417337">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListFlowLogs__p143631224193311">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListFlowLogs__p73631124193310">Error code.</p>
</td>
</tr>
<tr id="ListFlowLogs__row8238724113314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListFlowLogs__p1336314241336">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListFlowLogs__p163631242333">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListFlowLogs__p1736312493318">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListFlowLogs__section936342463314"><h4 class="sectiontitle">Example Requests</h4><p id="ListFlowLogs__p43632249331">Query the flow logs on the first page of the firewall with the ID 2af58b7c-893c-4453-a984-bdd9b1bd6318 in the project 9d80d070b6d44942af73c9c3d38e0429. The query time range is 1663555012000 to 1664159798000.</p>
<pre class="screen" id="ListFlowLogs__screen163641524173318">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/cfw/logs/flow?fw_instance_id=2af58b7c-893c-4453-a984-bdd9b1bd6318&amp;start_time=1663555012000&amp;end_time=1664159798000&amp;limit=10</pre>
</div>
<div class="section" id="ListFlowLogs__section13364192413336"><h4 class="sectiontitle">Example Responses</h4><p id="ListFlowLogs__p2036442443313"><strong id="ListFlowLogs__b83642024193320">Status code: 200</strong></p>
<p id="ListFlowLogs__p163641324103315">Value returned for flow log query.</p>
<pre class="screen" id="ListFlowLogs__screen103641424183318">{
"data" : {
"limit" : 10,
"records" : [ {
"app" : "SSH",
"bytes" : 34.5,
"direction" : "out2in",
"dst_ip" : "100.95.148.49",
"dst_port" : 22,
"end_time" : 1664155493000,
"log_id" : "76354",
"packets" : 25,
"protocol" : "TCP",
"src_ip" : "100.93.27.17",
"src_port" : 49634,
"start_time" : 1664155428000,
"src_province_id" : "source province id",
"src_province_name" : "source province name",
"src_city_id" : "source city id",
"src_city_name" : "source city name",
"dst_province_id" : "dst province id",
"dst_province_name" : "dst province name",
"dst_city_id" : "dst city id",
"dst_city_name" : "dst city name"
} ],
"total" : 1
}
}</pre>
<p id="ListFlowLogs__p17365124113310"><strong id="ListFlowLogs__b1436592419338">Status code: 400</strong></p>
<p id="ListFlowLogs__p16365112403316">Bad Request</p>
<pre class="screen" id="ListFlowLogs__screen73658245335">{
"error_code" : "CFW.00500002",
"error_msg" : "Invalid interval."
}</pre>
</div>
<div class="section" id="ListFlowLogs__section13701524123316"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFlowLogs__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListFlowLogs__row1225413243331"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListFlowLogs__p737017245332">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListFlowLogs__p03701824173313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFlowLogs__row4254192410337"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListFlowLogs__p93701924113310">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListFlowLogs__p193705242335">Value returned for flow log query.</p>
</td>
</tr>
<tr id="ListFlowLogs__row19254162443313"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListFlowLogs__p837082413311">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListFlowLogs__p637092413333">Bad Request</p>
</td>
</tr>
<tr id="ListFlowLogs__row13254162463313"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListFlowLogs__p1637042419331">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListFlowLogs__p4370424173314">Unauthorized</p>
</td>
</tr>
<tr id="ListFlowLogs__row62541424113319"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListFlowLogs__p10370182410339">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListFlowLogs__p103701024113318">Forbidden</p>
</td>
</tr>
<tr id="ListFlowLogs__row112541524123318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListFlowLogs__p1237032411336">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListFlowLogs__p1437042415335">Not Found</p>
</td>
</tr>
<tr id="ListFlowLogs__row1025412453318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListFlowLogs__p10371224153317">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListFlowLogs__p13371172414334">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListFlowLogs__section637172418336"><h4 class="sectiontitle">Error Codes</h4><p id="ListFlowLogs__p14371122419339">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_300000008.html">Log Management</a></div>
</div>
</div>
View Git Blame Copy Permalink