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>
193 lines
16 KiB
HTML
193 lines
16 KiB
HTML
<a name="vpc_firewall_0014"></a><a name="vpc_firewall_0014"></a>
|
|
|
|
<h1 class="topictitle1">Querying a <span id="text1165241194719">Firewall</span> Group</h1>
|
|
<div id="body1495598977068"><div class="section" id="vpc_firewall_0014__section39340300132713"><h4 class="sectiontitle">Function</h4><p id="vpc_firewall_0014__p26454036132713">This API is used to query details about a specific <span id="vpc_firewall_0014__text93827220506"></span><span id="vpc_firewall_0014__text938202214505">firewall</span> group.</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0014__section36516119132713"><h4 class="sectiontitle">URI</h4><p id="vpc_firewall_0014__p419819205520">GET /v2.0/fwaas/firewall_groups/{firewall_group_id}</p>
|
|
<div class="p" id="vpc_firewall_0014__p4978924174213"><a href="#vpc_firewall_0014__table18880184689">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="vpc_firewall_0014__table18880184689"></a><a name="table18880184689"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0014__table18880184689" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_firewall_0014__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_0014__p209684410817"><strong id="vpc_firewall_0014__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_0014__p69681441386"><strong id="vpc_firewall_0014__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_0014__p1096813412811"><strong id="vpc_firewall_0014__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_0014__p139686416813"><strong id="vpc_firewall_0014__b8423527061645">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0014__row19681041189"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="vpc_firewall_0014__p1682422682817">firewall_group_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_0014__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_0014__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_0014__p109701641488">Specifies the <span id="vpc_firewall_0014__text4995142655011"></span><span id="vpc_firewall_0014__text09961526105010">firewall</span> group ID, which uniquely identifies the <span id="vpc_firewall_0014__text1676791018256"></span><span id="vpc_firewall_0014__text9769141010258">firewall</span> group. The <strong id="vpc_firewall_0014__b3667827162511">fire_group_id</strong> value is used as the filter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0014__section17948186132713"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_firewall_0014__p3626252132713">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0014__section10868141791416"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_firewall_0014__screen19711335101411">GET https://{Endpoint}/v2.0/fwaas/firewall_groups/a504a4cf-9300-40e0-b2d4-649bd157c55a</pre>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0014__section7113297132713"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0014__table31400393132713" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_firewall_0014__row29671115132713"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_firewall_0014__p40935942132713">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_0014__p111081132713">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_0014__p59152418132713">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0014__row6968505132713"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_firewall_0014__p61606520132713">firewall_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_firewall_0014__p13430132393915"><a href="#vpc_firewall_0014__table31629250121127">firewall_group </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_0014__p14666204132713">Specifies the firewall group. For details, see <a href="#vpc_firewall_0014__table31629250121127">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_firewall_0014__table31629250121127"></a><a name="table31629250121127"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_firewall_0014__table31629250121127" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_firewall_0014__b1312623318397">Firewall Group</strong> objects</caption><thead align="left"><tr id="vpc_firewall_0014__row45711693121127"><th align="left" class="cellrowborder" valign="top" width="35.3%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_firewall_0014__p46819705121127"><strong id="vpc_firewall_0014__b054783493914">Attribute</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.57%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_firewall_0014__p35064605121127"><strong id="vpc_firewall_0014__b0248163517394">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.13%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_firewall_0014__p11952850121127"><strong id="vpc_firewall_0014__b1590273553919">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_firewall_0014__row20395689121127"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p50168503121127">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p47513116121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p62072725121127">Specifies the UUID of the <span id="vpc_firewall_0014__text133868349259"></span><span id="vpc_firewall_0014__text153931234122518">firewall</span> group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row34896104121127"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p52608071121127">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p59846605121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p28604909121127">Specifies the name of the <span id="vpc_firewall_0014__text19117123732519"></span><span id="vpc_firewall_0014__text6118237202516">firewall</span> group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row11129246121127"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p39887063121127">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p28745735121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p35639020121127">Provides supplementary information about the <span id="vpc_firewall_0014__text213594015256"></span><span id="vpc_firewall_0014__text171425403257">firewall</span> group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row677472121127"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p60717947121127">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p65871708121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p10487112">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row38137474121127"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p35500294121127">ingress_firewall_policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p49995809121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p56499442121127">Specifies the <span id="vpc_firewall_0014__text1733434282516"></span><span id="vpc_firewall_0014__text133564202511">firewall</span> policy for inbound traffic.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row9094936121127"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p34911245121127">egress_firewall_policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p44624490121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p37100641121127">Specifies the <span id="vpc_firewall_0014__text520311446253"></span><span id="vpc_firewall_0014__text1520534415251">firewall</span> policy for outbound traffic.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row31622902121127"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p65911012121127">ports</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p15651147173911">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p61002567121127">Specifies the list of ports bound with the <span id="vpc_firewall_0014__text11840104692514"></span><span id="vpc_firewall_0014__text284264614253">firewall</span> group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row48186031121127"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p33368479121127">public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p7938198121127">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p56166201121127">Specifies whether the firewall group can be shared by different tenants.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row60912436121127"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p66273781121127">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p7141533121127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p6468335121127">Specifies the status of the <span id="vpc_firewall_0014__text203467499256"></span><span id="vpc_firewall_0014__text183534498256">firewall</span> policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row59833296121127"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p44051842121127">admin_state_up</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p58587899121127">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p3428646121127">Specifies the administrative status of the <span id="vpc_firewall_0014__text203451204212"></span><span id="vpc_firewall_0014__text13519082119">firewall</span>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row7228115213486"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p53071912134918">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p1731011220498">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p66091240132915">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row196121757175216"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p1953114119914">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p595318416919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p1395374115919">Specifies the time (UTC) when the resource is created.</p>
|
|
<p id="vpc_firewall_0014__p65980291419">Format: <em id="vpc_firewall_0014__i19842530919">yyyy-MM-ddTHH:mm:ss</em></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_firewall_0014__row162182023115519"><td class="cellrowborder" valign="top" width="35.3%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_firewall_0014__p139719548912">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.57%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_firewall_0014__p53971154594">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.13%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_firewall_0014__p1339713549918">Specifies the time (UTC) when the resource is updated.</p>
|
|
<p id="vpc_firewall_0014__p15297192516128">Format: <em id="vpc_firewall_0014__i015943614114">yyyy-MM-ddTHH:mm:ss</em></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0014__section46668427132713"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_firewall_0014__screen19644845101419">{
|
|
"firewall_group": {
|
|
"status": "ACTIVE",
|
|
"public": false,
|
|
"egress_firewall_policy_id": null,
|
|
"name": "bobby_fwg1",
|
|
"admin_state_up": true,
|
|
"ports": [
|
|
"16e6d779-15e9-48fb-abc5-b86457792a15"
|
|
],
|
|
"tenant_id": "23c8a121505047b6869edf39f3062712",
|
|
"id": "a504a4cf-9300-40e0-b2d4-649bd157c55a",
|
|
"ingress_firewall_policy_id": "fed2d88f-d0e7-4cc5-bd7e-c495f67037b6",
|
|
"description": "test",
|
|
"project_id": "23c8a121505047b6869edf39f3062712",
|
|
"created_at": "2018-09-12T08:24:14",
|
|
"updated_at": "2018-09-12T08:24:14"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0014__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_firewall_0014__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_firewall_0014__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_firewall_0014__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
<p id="vpc_firewall_0014__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>
|
|
|