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>
151 lines
12 KiB
HTML
151 lines
12 KiB
HTML
<a name="vpc_firewall_0007"></a><a name="vpc_firewall_0007"></a>
|
|
|
|
<h1 class="topictitle1">Querying a <span id="text15658433163710">Firewall</span> Policy</h1>
|
|
<div id="body1495598977068"><div class="section" id="vpc_firewall_0007__section915947313242"><h4 class="sectiontitle">Function</h4><p id="vpc_firewall_0007__p5367244413242">This API is used to query details about a specific <span id="vpc_firewall_0007__text42091344194014"></span><span id="vpc_firewall_0007__text16209174444013">firewall</span> policy.</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0007__section2518841213242"><h4 class="sectiontitle">URI</h4><p id="vpc_firewall_0007__p1943897184415">GET /v2.0/fwaas/firewall_policies/{firewall_policy_id}</p>
|
|
<div class="p" id="vpc_firewall_0007__p89919591412"><a href="#vpc_firewall_0007__table18880184689">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="vpc_firewall_0007__table18880184689"></a><a name="table18880184689"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0007__table18880184689" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_firewall_0007__row13968641385"><th align="left" class="cellrowborder" valign="top" width="22.222222222222225%" id="mcps1.3.2.3.2.2.5.1.1"><p id="vpc_firewall_0007__p209684410817"><strong id="vpc_firewall_0007__b842352706195711">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.14141414141414%" id="mcps1.3.2.3.2.2.5.1.2"><p id="vpc_firewall_0007__p69681441386"><strong id="vpc_firewall_0007__b84235270615219">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.27272727272727%" id="mcps1.3.2.3.2.2.5.1.3"><p id="vpc_firewall_0007__p1096813412811"><strong id="vpc_firewall_0007__b842352706145623">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.36363636363636%" id="mcps1.3.2.3.2.2.5.1.4"><p id="vpc_firewall_0007__p139686416813"><strong id="vpc_firewall_0007__b8423527061645">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0007__row19681041189"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="vpc_firewall_0007__p1682422682817">firewall_policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="vpc_firewall_0007__p1797015416817">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="vpc_firewall_0007__p19701411813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="vpc_firewall_0007__p109701641488">Specifies the <span id="vpc_firewall_0007__text183721255114017"></span><span id="vpc_firewall_0007__text43721055154020">firewall</span> policy ID, which uniquely identifies the <span id="vpc_firewall_0007__text128671827427"></span><span id="vpc_firewall_0007__text11869724429">firewall</span> policy. The <strong id="vpc_firewall_0007__b1857978114210">firewall_policy_id</strong> value is used as the filter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0007__section5030939813242"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_firewall_0007__p3466543413242">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0007__section1493131520138"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_firewall_0007__screen272082912139">GET https://{Endpoint}/v2.0/fwaas/firewall_policies/fed2d88f-d0e7-4cc5-bd7e-c495f67037b6</pre>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0007__section2488003713242"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0007__table6694832013242" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_firewall_0007__row6068200913242"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_firewall_0007__p963376713242">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_0007__p303129213242">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_0007__p1024114813242">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0007__row4115792613242"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_firewall_0007__p1605288813242">firewall_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_firewall_0007__p2885681613242"><a href="#vpc_firewall_0007__table17002720121127">firewall_policy</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_0007__p6121237313242">Specifies the firewall policy. For details, see <a href="#vpc_firewall_0007__table17002720121127">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_firewall_0007__table17002720121127"></a><a name="table17002720121127"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0007__table17002720121127" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_firewall_0007__b113617398614">Firewall Policy</strong> objects</caption><thead align="left"><tr id="vpc_firewall_0007__row16929792121127"><th align="left" class="cellrowborder" valign="top" width="32.083208320832085%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_firewall_0007__p18873879121127"><strong id="vpc_firewall_0007__b2095220401262">Attribute</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.632263226322635%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_firewall_0007__p12638309121127"><strong id="vpc_firewall_0007__b823616426612">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.28452845284529%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_firewall_0007__p61199938121127"><strong id="vpc_firewall_0007__b15115144319610">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0007__row46402691121127"><td class="cellrowborder" valign="top" width="32.083208320832085%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0007__p11805115121127">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.632263226322635%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0007__p13006089121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.28452845284529%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0007__p13152683121127">Specifies the UUID of the <span id="vpc_firewall_0007__text92121413124220"></span><span id="vpc_firewall_0007__text62171713144216">firewall</span> policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0007__row9858171121127"><td class="cellrowborder" valign="top" width="32.083208320832085%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0007__p49865700121127">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.632263226322635%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0007__p6225460121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.28452845284529%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0007__p40337147121127">Specifies the name of the <span id="vpc_firewall_0007__text6647191864213"></span><span id="vpc_firewall_0007__text13648111812422">firewall</span> policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0007__row61803802121127"><td class="cellrowborder" valign="top" width="32.083208320832085%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0007__p39621949121127">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.632263226322635%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0007__p66053143121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.28452845284529%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0007__p15357220121127">Provides supplementary information about the <span id="vpc_firewall_0007__text1964242018422"></span><span id="vpc_firewall_0007__text3643920164220">firewall</span> policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0007__row57644277121127"><td class="cellrowborder" valign="top" width="32.083208320832085%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0007__p9761241121127">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.632263226322635%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0007__p20138053121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.28452845284529%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0007__p10487112">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0007__row33369184121127"><td class="cellrowborder" valign="top" width="32.083208320832085%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0007__p16940942121127">firewall_rules</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.632263226322635%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0007__p1916011339370">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.28452845284529%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0007__p53455884121127">Specifies the firewall rules referenced by the <span id="vpc_firewall_0007__text22314241429"></span><span id="vpc_firewall_0007__text729424104211">firewall</span> policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0007__row717167121127"><td class="cellrowborder" valign="top" width="32.083208320832085%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0007__p30704110121127">audited</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.632263226322635%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0007__p10804884121127">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.28452845284529%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0007__p3925300121127">Specifies the audit flag.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0007__row40905717121127"><td class="cellrowborder" valign="top" width="32.083208320832085%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0007__p16821838121127">public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.632263226322635%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0007__p49691806121127">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.28452845284529%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0007__p31604739121127">Specifies whether the firewall policy can be shared by different tenants.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0007__row109594223354"><td class="cellrowborder" valign="top" width="32.083208320832085%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0007__p870051413911">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.632263226322635%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0007__p17700201411911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.28452845284529%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0007__p20137347142815">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0007__section478525713242"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_firewall_0007__screen18467104512132">{
|
|
"firewall_policy": {
|
|
"description": "",
|
|
"firewall_rules": [
|
|
"3c0e6267-73df-4d9a-87a6-e226f2db2036"
|
|
],
|
|
"tenant_id": "23c8a121505047b6869edf39f3062712",
|
|
"public": false,
|
|
"id": "fed2d88f-d0e7-4cc5-bd7e-c495f67037b6",
|
|
"audited": false,
|
|
"name": "bobby_fwp1",
|
|
"project_id": "23c8a121505047b6869edf39f3062712"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0007__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_firewall_0007__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0007__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_firewall_0007__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
<p id="vpc_firewall_0007__p8060118"></p>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_firewall_0000.html">Firewall</a></div>
|
|
</div>
|
|
</div>
|
|
|