forked from docs/doc-exports
Qin Ying, Fan
310d2d9eb1
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
197 lines
16 KiB
HTML
197 lines
16 KiB
HTML
<a name="vpc_firewall_0002"></a><a name="vpc_firewall_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying a <span id="text16243174543411">Firewall</span> Rule</h1>
|
|
<div id="body1495598977068"><div class="section" id="vpc_firewall_0002__section65879037122957"><h4 class="sectiontitle">Function</h4><p id="vpc_firewall_0002__p66929261122957">This API is used to query details about a specific <span id="vpc_firewall_0002__text1191461310355"></span><span id="vpc_firewall_0002__text18914111393520">firewall</span> rule.</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0002__section46813763122957"><h4 class="sectiontitle">URI</h4><p id="vpc_firewall_0002__p16938175712330">GET /v2.0/fwaas/firewall_rules/{firewall_rule_id}</p>
|
|
<p id="vpc_firewall_0002__p17789155311512"><a href="#vpc_firewall_0002__table18880184689">Table 1</a> describes the parameters.</p>
|
|
<div class="p" id="vpc_firewall_0002__p17116167326">
|
|
<div class="tablenoborder"><a name="vpc_firewall_0002__table18880184689"></a><a name="table18880184689"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0002__table18880184689" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_firewall_0002__row13968641385"><th align="left" class="cellrowborder" valign="top" width="22.222222222222225%" id="mcps1.3.2.4.1.2.5.1.1"><p id="vpc_firewall_0002__p209684410817"><strong id="vpc_firewall_0002__b842352706195711">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.14141414141414%" id="mcps1.3.2.4.1.2.5.1.2"><p id="vpc_firewall_0002__p69681441386"><strong id="vpc_firewall_0002__b84235270615219">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.27272727272727%" id="mcps1.3.2.4.1.2.5.1.3"><p id="vpc_firewall_0002__p1096813412811"><strong id="vpc_firewall_0002__b842352706145623">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.36363636363636%" id="mcps1.3.2.4.1.2.5.1.4"><p id="vpc_firewall_0002__p139686416813"><strong id="vpc_firewall_0002__b8423527061645">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0002__row19681041189"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.2.4.1.2.5.1.1 "><p id="vpc_firewall_0002__p1682422682817">firewall_rule_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.2.4.1.2.5.1.2 "><p id="vpc_firewall_0002__p1797015416817">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.2.4.1.2.5.1.3 "><p id="vpc_firewall_0002__p19701411813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.2.4.1.2.5.1.4 "><p id="vpc_firewall_0002__p158091718125714">Specifies the <span id="vpc_firewall_0002__text16376161933514"></span><span id="vpc_firewall_0002__text8376191963520">firewall</span> rule ID, which uniquely identifies the <span id="vpc_firewall_0002__text1799412551509"></span><span id="vpc_firewall_0002__text199811551704">firewall</span> rule. The <strong id="vpc_firewall_0002__b1046613449013">firewall_rule_id</strong> value is used as the filter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0002__section25083919122957"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_firewall_0002__p53069288122957">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0002__section953315189158"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_firewall_0002__screen15192113111511">GET https://{Endpoint}/v2.0/fwaas/firewall_rules/514e6776-162a-4b5d-ab8b-aa36b86655ef</pre>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0002__section24140738122957"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0002__table22071969122957" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_firewall_0002__row27211568122957"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_firewall_0002__p41925459122957">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.11%" id="mcps1.3.5.2.2.4.1.2"><p id="vpc_firewall_0002__p18784029122957">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.540000000000006%" id="mcps1.3.5.2.2.4.1.3"><p id="vpc_firewall_0002__p64308775122957">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0002__row14692262122957"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_firewall_0002__p36226380122957">firewall_rule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_firewall_0002__p60366906122957"><a href="#vpc_firewall_0002__table38646929121127">firewall_rule</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.540000000000006%" headers="mcps1.3.5.2.2.4.1.3 "><p id="vpc_firewall_0002__p61314665122957">Specifies the firewall rule objects. For details, see <a href="#vpc_firewall_0002__table38646929121127">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_firewall_0002__table38646929121127"></a><a name="table38646929121127"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0002__table38646929121127" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_firewall_0002__b944701982217">Firewall Rule</strong> objects</caption><thead align="left"><tr id="vpc_firewall_0002__row18263398121127"><th align="left" class="cellrowborder" valign="top" width="32.76%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_firewall_0002__p2027461121127"><strong id="vpc_firewall_0002__b131671821192220">Attribute</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.69%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_firewall_0002__p51747644121127"><strong id="vpc_firewall_0002__b7134162222211">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.550000000000004%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_firewall_0002__p12805757121127"><strong id="vpc_firewall_0002__b685572315226">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0002__row39528007121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p7362024121127">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p53278848121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p13095685121127">Specifies the UUID of the <span id="vpc_firewall_0002__text1953193818"></span><span id="vpc_firewall_0002__text179601033118">firewall</span> rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row3417421121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p16296528121127">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p52887833121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p29399172121127">Specifies the <span id="vpc_firewall_0002__text3240191220110"></span><span id="vpc_firewall_0002__text1824619125114">firewall</span> rule name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row33772147121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p62102623121127">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p30062050121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p64485971121127">Provides supplementary information about the <span id="vpc_firewall_0002__text8197123220118"></span><span id="vpc_firewall_0002__text142033321312">firewall</span> rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row39157453121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p40485546121127">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p20366062121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p10487112">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row13612334121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p3945861121127">public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p53059091121127">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p46007536121127">Specifies whether the firewall rule can be shared by different tenants.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row66347377121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p7361769121127">protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p50019959121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p36897817121127">Specifies the IP protocol.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row8703753121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p5943474121127">source_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p59206978121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p62826249121127">Specifies the source port number or port number range.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row52935496121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p12876203121127">destination_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p66631365121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p66851026121127">Specifies the destination port number or port number range.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row37973187121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p18090983121127">ip_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p15064211121127">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p10402054121127">Specifies the IP protocol version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row34581454121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p61377852121127">source_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p36483585121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p31475962121127">Specifies the source IP address or CIDR block.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row13949121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p43901244121127">destination_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p14651426121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p53743554121127">Specifies the destination IP address or CIDR block.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row33223843121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p40131900121127">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p952780121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p16135729121127">Specifies action performed on traffic passing through the <span id="vpc_firewall_0002__text28096361115"></span><span id="vpc_firewall_0002__text1181416361016">firewall</span>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row11398101121127"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p50347088121127">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p46161809121127">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p57324252121127">Specifies whether the <span id="vpc_firewall_0002__text86530384111"></span><span id="vpc_firewall_0002__text4653193816117">firewall</span> rule is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0002__row1574912215580"><td class="cellrowborder" valign="top" width="32.76%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0002__p1312116475819">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0002__p5125543583">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.550000000000004%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0002__p47094254282">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0002__section16344236122957"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_firewall_0002__screen1689115392158">{
|
|
"firewall_rule": {
|
|
"protocol": "tcp",
|
|
"description": "update check parameter",
|
|
"source_ip_address": "116.66.184.0/24",
|
|
"destination_ip_address": "0.0.0.0/0",
|
|
"destination_port": null,
|
|
"source_port": null,
|
|
"id": "514e6776-162a-4b5d-ab8b-aa36b86655ef",
|
|
"name": "test",
|
|
"tenant_id": "a1c6f90c94334bd2953d9a61b8031a68",
|
|
"project_id": "a1c6f90c94334bd2953d9a61b8031a68",
|
|
"enabled": true,
|
|
"action": "allow",
|
|
"ip_version": 4,
|
|
"public": false
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0002__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_firewall_0002__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0002__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_firewall_0002__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>
|
|
|