forked from docs/doc-exports
gtema
4cfecba474
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com> Co-authored-by: gtema <artem.goncharov@gmail.com> Co-committed-by: gtema <artem.goncharov@gmail.com>
201 lines
16 KiB
HTML
201 lines
16 KiB
HTML
<a name="vpc_flow_0003"></a><a name="vpc_flow_0003"></a>
|
|
|
|
<h1 class="topictitle1">Querying a VPC Flow Log</h1>
|
|
<div id="body1548225405722"><div class="section" id="vpc_flow_0003__section16284153465111"><h4 class="sectiontitle">Function</h4><p id="vpc_flow_0003__p144092346513">This API is used to query a VPC flow log.</p>
|
|
</div>
|
|
<div class="section" id="vpc_flow_0003__section1828473425111"><h4 class="sectiontitle">URI</h4><p id="vpc_flow_0003__p940953475114">GET /v1/{project_id}/fl/flow_logs/{flowlog_id}</p>
|
|
<p id="vpc_flow_0003__p17789155311512"><a href="#vpc_flow_0003__table152848346516">Table 1</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="vpc_flow_0003__table152848346516"></a><a name="table152848346516"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_flow_0003__table152848346516" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_flow_0003__row540910347514"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="vpc_flow_0003__p140923405110"><strong id="vpc_flow_0003__b8828713185411">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.2"><p id="vpc_flow_0003__p24091234175119"><strong id="vpc_flow_0003__b96034145547">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.3"><p id="vpc_flow_0003__p94091034205117"><strong id="vpc_flow_0003__b3510181513543">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.4"><p id="vpc_flow_0003__p144091344518"><strong id="vpc_flow_0003__b02181616195415">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_flow_0003__row15409143495116"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_flow_0003__p840923411517">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_flow_0003__p194091934115116">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_flow_0003__p16409203465120">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_flow_0003__p10487112">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__row17409234195116"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_flow_0003__p84091634135115">flowlog_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_flow_0003__p3409123455117">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_flow_0003__p3409123418514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_flow_0003__p640920345511">Specifies the VPC flow log ID, which uniquely identifies the VPC flow log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_flow_0003__section2284934175115"><h4 class="sectiontitle">Request Message</h4><ul id="vpc_flow_0003__ul12409173425114"><li id="vpc_flow_0003__li20409123418517">Request parameter<p id="vpc_flow_0003__p10409133412517"><a name="vpc_flow_0003__li20409123418517"></a><a name="li20409123418517"></a>None</p>
|
|
</li><li id="vpc_flow_0003__li7409934165113">Example request<pre class="screen" id="vpc_flow_0003__screen162446521497">GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/1e10cd9d-742a-4d36-a9fd-aee9784336ff</pre>
|
|
</li></ul>
|
|
<p id="vpc_flow_0003__p1740914341517"></p>
|
|
</div>
|
|
<div class="section" id="vpc_flow_0003__section1629919342519"><h4 class="sectiontitle">Response Message</h4><ul id="vpc_flow_0003__ul17409123419517"><li id="vpc_flow_0003__li2040914341514">Response parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_flow_0003__table9299113405110" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_flow_0003__row11409334115117"><th align="left" class="cellrowborder" valign="top" width="18.18%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpc_flow_0003__p14409103419511"><strong id="vpc_flow_0003__b1488141212551">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.25%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpc_flow_0003__p34093341512"><strong id="vpc_flow_0003__b12466413195518">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpc_flow_0003__p240915343512"><strong id="vpc_flow_0003__b1333431495510">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_flow_0003__row940963413519"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpc_flow_0003__p84095341513">flow_log</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpc_flow_0003__p540943475116"><a href="#vpc_flow_0003__table17299234185110">flow_log</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpc_flow_0003__p34092034125118">Specifies the <strong id="vpc_flow_0003__b38591633228">FlowLog</strong> objects. For details, see <a href="#vpc_flow_0003__table17299234185110">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_flow_0003__table17299234185110"></a><a name="table17299234185110"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_flow_0003__table17299234185110" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="vpc_flow_0003__b826315202216">FlowLog</strong> field</caption><thead align="left"><tr id="vpc_flow_0003__en-us_topic_0151499961_row1993725815391"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpc_flow_0003__en-us_topic_0151499961_p293714582397"><strong>Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpc_flow_0003__en-us_topic_0151499961_p149371458113917"><strong id="vpc_flow_0003__b2008366504">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpc_flow_0003__en-us_topic_0151499961_p159376583395"><strong>Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_flow_0003__en-us_topic_0151499961_row29378583393"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1937205819397">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p5937105873915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p29371758183911">Specifies the VPC flow log UUID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row1293725816394"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p20937145883911">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p10937105813391">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p3618473146">Specifies the VPC flow log name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row6937758193914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1793711586397">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p15937135818397">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__p117815752110">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row8937258173912"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p593705817390">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p093712588392">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p26023187145">Provides supplementary information about the VPC flow log.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row7937205883910"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1393795823920">resource_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p10937858133920">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1293717582396">Specifies the type of resource on which to create the VPC flow log.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row189371758133919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p693745853910">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1893725843915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p893718589392">Specifies the unique resource ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row19371458163912"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p11937135813399">traffic_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p159371058143918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p49371958143918">Specifies the type of traffic to log.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row1993795813391"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p11937258153912">log_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1593716589399">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p13937458163911">Specifies the log group ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row69371358193919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p9937105811399">log_topic_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p3937195853911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p8937105811390">Specifies the log topic ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row149526285714"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1948613611718">admin_state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p11486936674">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p184867361474">Specifies whether to enable the VPC flow log function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row102334258716"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p74861036479">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1948613361478">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1092449185">Specifies the VPC flow log status.</p>
|
|
<ul id="vpc_flow_0003__en-us_topic_0151499961_ul12491821389"><li id="vpc_flow_0003__en-us_topic_0151499961_li1649621783"><strong id="vpc_flow_0003__b842352706192644">ACTIVE</strong>: Enabled</li><li id="vpc_flow_0003__en-us_topic_0151499961_li94915211488"><strong id="vpc_flow_0003__b84235270619274">DOWN</strong>: Disabled</li><li id="vpc_flow_0003__en-us_topic_0151499961_li8498211781"><strong id="vpc_flow_0003__b842352706192830">ERROR</strong>: Abnormal fault</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row593715813910"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p6937125803920">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p6937105823914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1193719586393">Specifies the time when the VPC flow log was created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_flow_0003__en-us_topic_0151499961_row0937358193913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_flow_0003__en-us_topic_0151499961_p1793713589392">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_flow_0003__en-us_topic_0151499961_p15937458113912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_flow_0003__en-us_topic_0151499961_p293725893919">Specifies the time when the VPC flow log was updated.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<p id="vpc_flow_0003__p74091034155114"></p>
|
|
<ul id="vpc_flow_0003__ul114092034115110"><li id="vpc_flow_0003__li940993415518">Example response<pre class="screen" id="vpc_flow_0003__screen14721916185116">{
|
|
"flow_log": {
|
|
"id": "35868d55-443e-4d5c-90a4-ac618dc45c1a",
|
|
"name": "flow",
|
|
"description": "just a test",
|
|
"tenant_id": "b2782e6708b8475c993e6064bc456bf8",
|
|
"resource_type": "port",
|
|
"resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde",
|
|
"traffic_type": "reject",
|
|
"log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff",
|
|
"log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
|
|
"created_at": "2019-01-14T11:03:02",
|
|
"updated_at": "2019-01-14T11:03:02"
|
|
"status": "ACTIVE",
|
|
"admin_state": true
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_flow_0003__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_flow_0003__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_flow_0003__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_flow_0003__p17281622133910">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_flow_0000.html">VPC Flow Log</a></div>
|
|
</div>
|
|
</div>
|
|
|