forked from laiweijian4/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>
345 lines
29 KiB
HTML
345 lines
29 KiB
HTML
<a name="vpc_firewall_0001"></a><a name="vpc_firewall_0001"></a>
|
|
|
|
<h1 class="topictitle1">Querying <span id="text5415194215349"></span><span id="text16243174543411">Firewall</span> Rules</h1>
|
|
<div id="body1495598977068"><div class="section" id="vpc_firewall_0001__section32978392122541"><h4 class="sectiontitle">Function</h4><p id="vpc_firewall_0001__p19510161663112">This API is used to query all <span id="vpc_firewall_0001__text564610196347"></span><span id="vpc_firewall_0001__text1964671963418">firewall</span> rules accessible to the tenant submitting the request. </p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0001__section11642292122541"><h4 class="sectiontitle">URI</h4><p id="vpc_firewall_0001__p97611239318">GET /v2.0/fwaas/firewall_rules</p>
|
|
<p id="vpc_firewall_0001__p9229356161812">Example:</p>
|
|
<pre class="screen" id="vpc_firewall_0001__screen15731182918425">GET https://{Endpoint}/v2.0/fwaas/firewall_rules?name={firewall_rule_name}&tenant_id={tenant_id}&public={is_public}&protocol={protocol}&ip_version={ip_version}&action={action}&enabled={is_enabled}</pre>
|
|
<p id="vpc_firewall_0001__p1055153135611">Example of querying rules by page</p>
|
|
<pre class="screen" id="vpc_firewall_0001__screen6349039695144">GET https://{Endpoint}/v2.0/fwaas/firewall_rules?limit=2&marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=False</pre>
|
|
<p id="vpc_firewall_0001__p191371050124211"><a href="#vpc_firewall_0001__table997509428">Table 1</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="vpc_firewall_0001__table997509428"></a><a name="table997509428"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0001__table997509428" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_firewall_0001__row11137135094218"><th align="left" class="cellrowborder" valign="top" width="14.72147214721472%" id="mcps1.3.2.8.2.5.1.1"><p id="vpc_firewall_0001__p91372500429"><strong id="vpc_firewall_0001__b10992125015714">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.64216421642164%" id="mcps1.3.2.8.2.5.1.2"><p id="vpc_firewall_0001__p20137350164218"><strong id="vpc_firewall_0001__b11301526712">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.8017801780178%" id="mcps1.3.2.8.2.5.1.3"><p id="vpc_firewall_0001__p1913719500427"><strong id="vpc_firewall_0001__b459514532714">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.83458345834583%" id="mcps1.3.2.8.2.5.1.4"><p id="vpc_firewall_0001__p2137125013423"><strong id="vpc_firewall_0001__b152910552719">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0001__row10137165064216"><td class="cellrowborder" valign="top" width="14.72147214721472%" headers="mcps1.3.2.8.2.5.1.1 "><p id="vpc_firewall_0001__p171379507423">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64216421642164%" headers="mcps1.3.2.8.2.5.1.2 "><p id="vpc_firewall_0001__p141378503428">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.8017801780178%" headers="mcps1.3.2.8.2.5.1.3 "><p id="vpc_firewall_0001__p5137450184219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.83458345834583%" headers="mcps1.3.2.8.2.5.1.4 "><p id="vpc_firewall_0001__p1013785017424">Specifies that the <span id="vpc_firewall_0001__text139172183518">firewall</span><span id="vpc_firewall_0001__text25322156350"></span> rule ID is used as the filtering condition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row313725054217"><td class="cellrowborder" valign="top" width="14.72147214721472%" headers="mcps1.3.2.8.2.5.1.1 "><p id="vpc_firewall_0001__p8137135074211">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64216421642164%" headers="mcps1.3.2.8.2.5.1.2 "><p id="vpc_firewall_0001__p14137175064212">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.8017801780178%" headers="mcps1.3.2.8.2.5.1.3 "><p id="vpc_firewall_0001__p171372050114214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.83458345834583%" headers="mcps1.3.2.8.2.5.1.4 "><p id="vpc_firewall_0001__p141374506425">Specifies that the <span id="vpc_firewall_0001__text165930133514">firewall</span><span id="vpc_firewall_0001__text105183083515"></span> rule name is used as the filtering condition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row1813745044211"><td class="cellrowborder" valign="top" width="14.72147214721472%" headers="mcps1.3.2.8.2.5.1.1 "><p id="vpc_firewall_0001__p9137175094217">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64216421642164%" headers="mcps1.3.2.8.2.5.1.2 "><p id="vpc_firewall_0001__p18137175015420">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.8017801780178%" headers="mcps1.3.2.8.2.5.1.3 "><p id="vpc_firewall_0001__p213715024219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.83458345834583%" headers="mcps1.3.2.8.2.5.1.4 "><p id="vpc_firewall_0001__p1913775016422">Specifies that the <span id="vpc_firewall_0001__text676215311354">firewall</span><span id="vpc_firewall_0001__text1276219317353"></span> rule description is used as the filtering condition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row61371650194212"><td class="cellrowborder" valign="top" width="14.72147214721472%" headers="mcps1.3.2.8.2.5.1.1 "><p id="vpc_firewall_0001__p1213825054216">ip_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64216421642164%" headers="mcps1.3.2.8.2.5.1.2 "><p id="vpc_firewall_0001__p313815504428">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.8017801780178%" headers="mcps1.3.2.8.2.5.1.3 "><p id="vpc_firewall_0001__p7138165014214">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.83458345834583%" headers="mcps1.3.2.8.2.5.1.4 "><p id="vpc_firewall_0001__p5526124316">Specifies that the IP address version is used as the filtering condition.</p>
|
|
<p id="vpc_firewall_0001__p121381950174212">The value can be <strong id="vpc_firewall_0001__b57616211365">4</strong> (IPv4) or <strong id="vpc_firewall_0001__b5761829368">6</strong> (IPv6).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row12138195084219"><td class="cellrowborder" valign="top" width="14.72147214721472%" headers="mcps1.3.2.8.2.5.1.1 "><p id="vpc_firewall_0001__p161385503424">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64216421642164%" headers="mcps1.3.2.8.2.5.1.2 "><p id="vpc_firewall_0001__p313855094219">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.8017801780178%" headers="mcps1.3.2.8.2.5.1.3 "><p id="vpc_firewall_0001__p13138145015423">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.83458345834583%" headers="mcps1.3.2.8.2.5.1.4 "><p id="vpc_firewall_0001__p167111932438">Specifies that the <span id="vpc_firewall_0001__text17980154303518">firewall</span><span id="vpc_firewall_0001__text1198034343516"></span> rule action is used as the filtering condition.</p>
|
|
<p id="vpc_firewall_0001__p13138135016424">The value can be <strong id="vpc_firewall_0001__b13939151601215">allow</strong> or <strong id="vpc_firewall_0001__b11939111671216">deny</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row131381450164218"><td class="cellrowborder" valign="top" width="14.72147214721472%" headers="mcps1.3.2.8.2.5.1.1 "><p id="vpc_firewall_0001__p1713811507429">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64216421642164%" headers="mcps1.3.2.8.2.5.1.2 "><p id="vpc_firewall_0001__p13138145094212">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.8017801780178%" headers="mcps1.3.2.8.2.5.1.3 "><p id="vpc_firewall_0001__p17138350194215">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.83458345834583%" headers="mcps1.3.2.8.2.5.1.4 "><p id="vpc_firewall_0001__p1564520515432">Specifies that the <span id="vpc_firewall_0001__text6581114912354">firewall</span><span id="vpc_firewall_0001__text185816495355"></span> rule is enabled is used as the filtering condition.</p>
|
|
<p id="vpc_firewall_0001__p513820509425">The value can be <strong id="vpc_firewall_0001__b156671052161214">true</strong> or <strong id="vpc_firewall_0001__b0667165216123">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row9138450124210"><td class="cellrowborder" valign="top" width="14.72147214721472%" headers="mcps1.3.2.8.2.5.1.1 "><p id="vpc_firewall_0001__p1138145015421">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64216421642164%" headers="mcps1.3.2.8.2.5.1.2 "><p id="vpc_firewall_0001__p713855094216">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.8017801780178%" headers="mcps1.3.2.8.2.5.1.3 "><p id="vpc_firewall_0001__p2138155019429">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.83458345834583%" headers="mcps1.3.2.8.2.5.1.4 "><p id="vpc_firewall_0001__p61381650184213">Specifies that the project ID is used as the filtering condition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row013818506422"><td class="cellrowborder" valign="top" width="14.72147214721472%" headers="mcps1.3.2.8.2.5.1.1 "><p id="vpc_firewall_0001__p613817506423">marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64216421642164%" headers="mcps1.3.2.8.2.5.1.2 "><p id="vpc_firewall_0001__p1513817501420">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.8017801780178%" headers="mcps1.3.2.8.2.5.1.3 "><p id="vpc_firewall_0001__p14138450134211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.83458345834583%" headers="mcps1.3.2.8.2.5.1.4 "><p id="vpc_firewall_0001__p28526205175853">Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.</p>
|
|
<p id="vpc_firewall_0001__p538818488578">This parameter can work together with the parameter <strong id="vpc_firewall_0001__vpc_api01_0003_b650614119446">limit</strong>.</p>
|
|
<ul id="vpc_firewall_0001__ul12704811125810"><li id="vpc_firewall_0001__vpc_api01_0003_li325418407124">If parameters <strong id="vpc_firewall_0001__vpc_api01_0003_b736582413514">marker</strong> and <strong id="vpc_firewall_0001__vpc_api01_0003_b17435293518">limit</strong> are not passed, all resource records will be returned.</li><li id="vpc_firewall_0001__vpc_api01_0003_li1923817171338">If the parameter <strong id="vpc_firewall_0001__vpc_api01_0003_b1505159195414">marker</strong> is not passed and the value of parameter <strong id="vpc_firewall_0001__vpc_api01_0003_b14146122925417">limit</strong> is set to <strong id="vpc_firewall_0001__vpc_api01_0003_b13594516546">10</strong>, the first 10 resource records will be returned.</li><li id="vpc_firewall_0001__vpc_api01_0003_li2076741203417">If the value of the parameter <strong id="vpc_firewall_0001__vpc_api01_0003_b13589356163415">marker</strong> is set to the resource ID of the 10th record and the value of parameter <strong id="vpc_firewall_0001__vpc_api01_0003_b1557415118357">limit</strong> is set to <strong id="vpc_firewall_0001__vpc_api01_0003_b10574171193511">10</strong>, the 11th to 20th resource records will be returned.</li><li id="vpc_firewall_0001__vpc_api01_0003_li108512113551">If the value of the parameter <strong id="vpc_firewall_0001__vpc_api01_0003_b9403193716543">marker</strong> is set to the resource ID of the 10th record and the parameter <strong id="vpc_firewall_0001__vpc_api01_0003_b10358823165519">limit</strong> is not passed, resource records starting from the 11th records (including 11th) will be returned.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row813815500428"><td class="cellrowborder" valign="top" width="14.72147214721472%" headers="mcps1.3.2.8.2.5.1.1 "><p id="vpc_firewall_0001__p813825014428">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64216421642164%" headers="mcps1.3.2.8.2.5.1.2 "><p id="vpc_firewall_0001__p5138155015425">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.8017801780178%" headers="mcps1.3.2.8.2.5.1.3 "><p id="vpc_firewall_0001__p41381750124216">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.83458345834583%" headers="mcps1.3.2.8.2.5.1.4 "><p id="vpc_firewall_0001__p2017153116589">Specifies the number of records that will be returned on each page. The value is from 0 to intmax.</p>
|
|
<p id="vpc_firewall_0001__p125192338584"><strong id="vpc_firewall_0001__vpc_api01_0003_b7164124258">limit</strong> can be used together with <strong id="vpc_firewall_0001__vpc_api01_0003_b15985310854">marker</strong>. For details, see the parameter description of <strong id="vpc_firewall_0001__vpc_api01_0003_b193281854847">marker</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0001__section16626865122541"><h4 class="sectiontitle">Request Message</h4><p id="vpc_firewall_0001__p43109138122541">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0001__section39494421122541"><h4 class="sectiontitle">Response Message</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0001__table48261844122541" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_firewall_0001__row41263599122541"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.4.2.2.4.1.1"><p id="vpc_firewall_0001__p23207162122541">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.11%" id="mcps1.3.4.2.2.4.1.2"><p id="vpc_firewall_0001__p46617019122541">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.540000000000006%" id="mcps1.3.4.2.2.4.1.3"><p id="vpc_firewall_0001__p38363364122541">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0001__row34200971122541"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_firewall_0001__p34822248122541">firewall_rules</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_firewall_0001__p125656569422">Array of <a href="#vpc_firewall_0001__table38646929121127">Firewall Rule</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.540000000000006%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_firewall_0001__p24293772122541">Specifies the firewall rule list. For details, see <a href="#vpc_firewall_0001__table38646929121127">Table 4</a>. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row431543194812"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_firewall_0001__p121201423154911">firewall_rules_links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_firewall_0001__p1412092384917">Array of <a href="#vpc_firewall_0001__table2049004519490">firewall_rules_link</a> Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.540000000000006%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_firewall_0001__p16120623194914">Specifies the pagination information. For details, see <a href="#vpc_firewall_0001__table2049004519490">Table 3</a>.</p>
|
|
<p id="vpc_firewall_0001__p1076914396212">The value of <strong id="vpc_firewall_0001__b121135712467">rel</strong> will be <strong id="vpc_firewall_0001__b1221612575464">next</strong> and that of <strong id="vpc_firewall_0001__b3217135719462">href</strong> will be a link only when <strong id="vpc_firewall_0001__b152177574463">limit</strong> is used for filtering and the number of resources exceeds the value of <strong id="vpc_firewall_0001__b22176570462">limit</strong> or 2000 (default value of <strong id="vpc_firewall_0001__b202171957124618">limit</strong>).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_firewall_0001__table2049004519490"></a><a name="table2049004519490"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0001__table2049004519490" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_firewall_0001__b132252219289">firewall_rules_link</strong> object</caption><thead align="left"><tr id="vpc_firewall_0001__row13534124514917"><th align="left" class="cellrowborder" valign="top" width="14.14%" id="mcps1.3.4.3.2.4.1.1"><p id="vpc_firewall_0001__p753404514915"><strong id="vpc_firewall_0001__b849124172814">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.14%" id="mcps1.3.4.3.2.4.1.2"><p id="vpc_firewall_0001__p25341945124920"><strong id="vpc_firewall_0001__b1753410285284">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="71.72%" id="mcps1.3.4.3.2.4.1.3"><p id="vpc_firewall_0001__p7534194512494"><strong id="vpc_firewall_0001__b1740129132817">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0001__row13534164554911"><td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_firewall_0001__p1534184524920">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_firewall_0001__p753415454494">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="71.72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_firewall_0001__p125340459499">Specifies the API link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row8534104512493"><td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_firewall_0001__p10534745114919">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_firewall_0001__p13534164534911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="71.72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_firewall_0001__p16534164584910">Specifies the relationship between the API link and the API version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_firewall_0001__table38646929121127"></a><a name="table38646929121127"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0001__table38646929121127" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_firewall_0001__b842352706201028">Firewall Rule</strong> objects</caption><thead align="left"><tr id="vpc_firewall_0001__row18263398121127"><th align="left" class="cellrowborder" valign="top" width="32.76%" id="mcps1.3.4.4.2.4.1.1"><p id="vpc_firewall_0001__p2027461121127"><strong id="vpc_firewall_0001__b1292213354594">Attribute</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.69%" id="mcps1.3.4.4.2.4.1.2"><p id="vpc_firewall_0001__p51747644121127"><strong id="vpc_firewall_0001__b19181113735917">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.550000000000004%" id="mcps1.3.4.4.2.4.1.3"><p id="vpc_firewall_0001__p12805757121127"><strong id="vpc_firewall_0001__b138496378592">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0001__row39528007121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p7362024121127">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p53278848121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p13095685121127">Specifies the UUID of the <span id="vpc_firewall_0001__text81311728133412"></span><span id="vpc_firewall_0001__text151311728123420">firewall</span> rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row3417421121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p16296528121127">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p52887833121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p29399172121127">Specifies the <span id="vpc_firewall_0001__text67642328343"></span><span id="vpc_firewall_0001__text17764193215344">firewall</span> rule name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row33772147121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p62102623121127">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p30062050121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p64485971121127">Provides supplementary information about the <span id="vpc_firewall_0001__text18997203693419"></span><span id="vpc_firewall_0001__text129977367341">firewall</span> rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row39157453121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p40485546121127">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p20366062121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p10487112">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row13612334121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p3945861121127">public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p53059091121127">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p46007536121127">Specifies whether the firewall rule can be shared by different tenants.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row66347377121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p7361769121127">protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p50019959121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p36897817121127">Specifies the IP protocol.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row8703753121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p5943474121127">source_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p59206978121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p62826249121127">Specifies the source port number or port number range.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row52935496121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p12876203121127">destination_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p66631365121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p66851026121127">Specifies the destination port number or port number range.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row37973187121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p18090983121127">ip_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p15064211121127">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p10402054121127">Specifies the IP protocol version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row34581454121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p61377852121127">source_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p36483585121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p31475962121127">Specifies the source IP address or CIDR block.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row13949121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p43901244121127">destination_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p14651426121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p53743554121127">Specifies the destination IP address or CIDR block.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row33223843121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p40131900121127">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p952780121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p16135729121127">Specifies action performed on traffic passing through the <span id="vpc_firewall_0001__text1197564210343"></span><span id="vpc_firewall_0001__text10975194213344">firewall</span>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row11398101121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p50347088121127">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p46161809121127">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p57324252121127">Specifies whether the <span id="vpc_firewall_0001__text4816164653410"></span><span id="vpc_firewall_0001__text9816174643411">firewall</span> rule is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0001__row1574912215580"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_firewall_0001__p1312116475819">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_firewall_0001__p5125543583">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.4.4.2.4.1.3 "><p id="vpc_firewall_0001__p187677200286">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0001__section60841704122541"><h4 class="sectiontitle">Example:</h4><p id="vpc_firewall_0001__p1775532019339">Example request</p>
|
|
<pre class="screen" id="vpc_firewall_0001__screen35512105122541">GET https://{Endpoint}/v2.0/fwaas/firewall_rules</pre>
|
|
</div>
|
|
<p id="vpc_firewall_0001__p896633020335">Example response</p>
|
|
<pre class="screen" id="vpc_firewall_0001__screen39780949105853">{
|
|
"firewall_rules": [
|
|
{
|
|
"protocol": "tcp",
|
|
"name": "crhfwruleupdate",
|
|
"mode": "normal",
|
|
"tenant_id": "f480f5d250824e5fafedcf05acf1419c",
|
|
"rule_profile": "",
|
|
"enabled": true,
|
|
"source_port": null,
|
|
"source_ip_address": null,
|
|
"destination_ip_address": null,
|
|
"firewall_policy_id": "b4f81251-c47a-4fe1-8579-6f9271d015d1",
|
|
"action": "deny",
|
|
"position": 1,
|
|
"ip_version": 4,
|
|
"shared": false,
|
|
"destination_port": null,
|
|
"id": "2a193015-4a88-4aa1-84ad-d4955adae707",
|
|
"description": "",
|
|
"project_id": "f480f5d250824e5fafedcf05acf1419c"
|
|
},
|
|
{
|
|
"protocol": "tcp",
|
|
"name": "update_firewall-role-tommy",
|
|
"mode": "mix",
|
|
"tenant_id": "a1c6f90c94334bd2953d9a61b8031a68",
|
|
"rule_profile": "",
|
|
"enabled": false,
|
|
"source_port": "20:50",
|
|
"source_ip_address": null,
|
|
"destination_ip_address": null,
|
|
"firewall_policy_id": null,
|
|
"action": "deny",
|
|
"position": null,
|
|
"ip_version": 4,
|
|
"shared": true,
|
|
"destination_port": "40:60",
|
|
"id": "db7a204c-9eb1-40a2-9bd6-ed5cfd3cff32",
|
|
"description": "update check parameter",
|
|
"project_id": "a1c6f90c94334bd2953d9a61b8031a68"
|
|
}
|
|
],
|
|
"firewall_rules_links": [
|
|
{ "rel": "previous",
|
|
"href": "https://{Endpoint}/v2.0/
|
|
fwaas/firewall_rules?marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=True"
|
|
}
|
|
]
|
|
}</pre>
|
|
<div class="section" id="vpc_firewall_0001__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_firewall_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_firewall_0001__p7233105282813">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_firewall_0000.html">Firewall</a></div>
|
|
</div>
|
|
</div>
|
|
|