vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ecs/api-ref/en-us_topic_0090187679.html
Zaoxu, Li 4edaa4a4cc ECS API 20231016 version 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-04-29 11:04:13 +00:00

295 lines
26 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0090187679"></a><a name="EN-US_TOPIC_0090187679"></a>
<h1 class="topictitle1">Querying Security Groups (Discarded)</h1>
<div id="body1514024530118"><div class="section" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_section4176562"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p20641825">This API is used to query security groups.</p>
<p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p1146061620560">This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) &gt; Querying Security Groups" in <em id="EN-US_TOPIC_0090187679__i18141123194219">Virtual Private Network API Reference</em>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_section37589065"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0090187679__p1676674644017">GET /v2/{project_id}/os-security-groups</p>
<p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p66228246145352">GET /v2.1/{project_id}/os-security-groups</p>
<div class="p" id="EN-US_TOPIC_0090187679__p119942131715"><a href="#EN-US_TOPIC_0090187679__en-us_topic_0057973221_table55945983">Table 1</a> describes the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table55945983"></a><a name="en-us_topic_0057973221_table55945983"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table55945983" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row11302482"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0090187679__p5187119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0090187679__p17503500">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0090187679__p8497414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row49888896"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p14468758">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p31118786">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__p37593705">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="note" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_note2930710622554"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p6243736922554">Pagination query is not supported.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_section24815400"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p104631119103115">N/A</p>
</div>
<div class="section" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_section22012011"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0090187679__p8767141816172"><a href="#EN-US_TOPIC_0090187679__en-us_topic_0057973221_table66376806">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table66376806"></a><a name="en-us_topic_0057973221_table66376806"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table66376806" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row62274010"><th align="left" class="cellrowborder" valign="top" width="30.09%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0090187679__en-us_topic_0058745339_p39560242204918">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.09%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0090187679__en-us_topic_0058745339_p50263001204918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.82%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0090187679__en-us_topic_0058745339_p2596798204918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row1734205"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p6252912">security_groups</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p62079394">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p19210173">Specifies security groups. For details, see <a href="#EN-US_TOPIC_0090187679__en-us_topic_0057973221_table12520187">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table12520187"></a><a name="en-us_topic_0057973221_table12520187"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table12520187" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b897031316622">security_group</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row15746475"><th align="left" class="cellrowborder" valign="top" width="30.09%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0090187679__p183229295112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.09%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0090187679__p632282961111">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.82%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0090187679__p032218298115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row48113441"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p4874628">description</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p5258827116753">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p40886591">Specifies information about a security group. It must contain 0 to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row32435006"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p9989850">id</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p4707763316753">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p34125466">Specifies the security group ID in UUID format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row38693741"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p47185308">name</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p5607075516753">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p41135662">Specifies the security group name. It must contain 0 to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row34676638"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p57344266">rules</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p658933716753">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p19833643">Specifies security group rules. For details, see <a href="#EN-US_TOPIC_0090187679__en-us_topic_0057973221_table34485122">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row44285066"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p30320557">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p5130886116753">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p11196300">Specifies the tenant or project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table34485122"></a><a name="en-us_topic_0057973221_table34485122"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table34485122" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0090187679__b1203022145">security_group_rule</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row32580689"><th align="left" class="cellrowborder" valign="top" width="28.410000000000004%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0090187679__p63482327113">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.410000000000004%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0090187679__p123484326118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.18%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0090187679__p6348032131118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row25689027"><td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p4000465416720">parent_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p6039325916720">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.18%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p3085498416720">Specifies the associated security group ID in UUID format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row1068468"><td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p5545514116720">ip_protocol</p>
</td>
<td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p717072016720">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.18%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p5391322116720">Specifies the protocol type or the IP protocol number. The value can be <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b84235270618469">icmp</strong>, <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b84235270619524">tcp</strong>, <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b842352706184613">udp</strong>, or the IP protocol number.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row34266555"><td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p4437223016720">from_port</p>
</td>
<td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p5610229616720">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.18%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p2095114117818">Specifies the start port number. The value ranges from 1 to 65,535 and cannot be greater than <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b84235270692028">to_port</strong>.</p>
<p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p660857541795">When <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b842352706184658">ip_protocol</strong> is <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b84235270618473">icmp</strong>, this parameter indicates the ICMP type field with a length from 0 to 255 characters.</p>
<div class="note" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_note136113314412"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p203633310418">The ICMP message type is determined by the type field and code field in the packet. For details, see <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b842352706145053">Appendix</strong> &gt; <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b842352706145058">ICMP-Port Range Relationship Table</strong> in <em id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_i84235269714516">Virtual Private Cloud API Reference</em>. <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b441067081144424">port_range_min</strong> indicates the ICMP type field, and <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b55704280614455">port_range_max</strong> indicates the ICMP code field.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row12065659"><td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p951704916720">to_port</p>
</td>
<td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p5777809316720">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.18%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p698716017100">Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than <strong id="EN-US_TOPIC_0090187679__b1298811866">from_port</strong>.</p>
<p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p230471653415">When <strong id="EN-US_TOPIC_0090187679__b1243450372">ip_protocol</strong> is <strong id="EN-US_TOPIC_0090187679__b1525840556">icmp</strong>, this parameter indicates the ICMP code field with a length from 0 to 255 characters.</p>
<div class="note" id="EN-US_TOPIC_0090187679__note8882154911495"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0090187679__p3882649134916">The ICMP message type is determined by the type field and code field in the packet. For details, see <strong id="EN-US_TOPIC_0090187679__b2067251833">Appendix</strong> &gt; <strong id="EN-US_TOPIC_0090187679__b1923177049">ICMP-Port Range Relationship Table</strong> in <em id="EN-US_TOPIC_0090187679__i1777105355">Virtual Private Cloud API Reference</em>. <strong id="EN-US_TOPIC_0090187679__b1517186828">port_range_min</strong> indicates the ICMP type, and <strong id="EN-US_TOPIC_0090187679__b1397776372">port_range_max</strong> indicates the ICMP code.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row19467483"><td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p410745516720">ip_range</p>
</td>
<td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p5877646316720">Object</p>
</td>
<td class="cellrowborder" valign="top" width="43.18%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p6098836171215">Specifies the peer IP segment in CIDR format. For details, see <a href="#EN-US_TOPIC_0090187679__en-us_topic_0057973221_table4101480163218">Table 5</a>.</p>
<p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p3406419516720">Specify either <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b842352706153434">ip_range</strong> or <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b842352706153439">group</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row8411726"><td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p1686385816720">group</p>
</td>
<td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p1304659916720">Object</p>
</td>
<td class="cellrowborder" valign="top" width="43.18%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p35137339171315">Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see <a href="#EN-US_TOPIC_0090187679__en-us_topic_0057973221_table9527961163416">Table 6</a>.</p>
<p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p4707259516720">Specify either <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b1800397364144646">ip_range</strong> or <strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b1399083018144646">group</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row3083532"><td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p65824216720">id</p>
</td>
<td class="cellrowborder" valign="top" width="28.410000000000004%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p3323147916720">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.18%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p4664414216720">Specifies the security group rule ID in UUID format.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table4101480163218"></a><a name="en-us_topic_0057973221_table4101480163218"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table4101480163218" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="EN-US_TOPIC_0090187679__b747555484">ip_range</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row55642344163218"><th align="left" class="cellrowborder" valign="top" width="30.023002300230022%" id="mcps1.3.4.6.2.4.1.1"><p id="EN-US_TOPIC_0090187679__p163251137161116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.792979297929794%" id="mcps1.3.4.6.2.4.1.2"><p id="EN-US_TOPIC_0090187679__p33251637171113">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.184018401840184%" id="mcps1.3.4.6.2.4.1.3"><p id="EN-US_TOPIC_0090187679__p163403376116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row5649056163218"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.6.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p54920430163218">cidr</p>
</td>
<td class="cellrowborder" valign="top" width="29.792979297929794%" headers="mcps1.3.4.6.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p19369856163218">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.184018401840184%" headers="mcps1.3.4.6.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p48550802163218">Specifies the peer IP segment in CIDR format.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table9527961163416"></a><a name="en-us_topic_0057973221_table9527961163416"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_table9527961163416" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_b842352706185646">group</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row57542164163416"><th align="left" class="cellrowborder" valign="top" width="29.690000000000005%" id="mcps1.3.4.7.2.4.1.1"><p id="EN-US_TOPIC_0090187679__p2231840201112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.460000000000004%" id="mcps1.3.4.7.2.4.1.2"><p id="EN-US_TOPIC_0090187679__p183984018118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.85%" id="mcps1.3.4.7.2.4.1.3"><p id="EN-US_TOPIC_0090187679__p03911409118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row46600064163416"><td class="cellrowborder" valign="top" width="29.690000000000005%" headers="mcps1.3.4.7.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p16508853163416">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="29.460000000000004%" headers="mcps1.3.4.7.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p62148702163416">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.85%" headers="mcps1.3.4.7.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p4179246163416">Specifies the ID of the tenant of the peer security group.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_row37613216163416"><td class="cellrowborder" valign="top" width="29.690000000000005%" headers="mcps1.3.4.7.2.4.1.1 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p26771660163416">name</p>
</td>
<td class="cellrowborder" valign="top" width="29.460000000000004%" headers="mcps1.3.4.7.2.4.1.2 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p21020848163416">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.85%" headers="mcps1.3.4.7.2.4.1.3 "><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_p9073859163416">Specifies the name of the peer security group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_section63890372"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_screen17926664">GET https://{endpoint}/v2/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups
GET https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups</pre>
</div>
<div class="section" id="EN-US_TOPIC_0090187679__section14391225182618"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0090187679__screen541572582619">{
"security_groups": [
{
"rules": [
{
"from_port": null,
"group": {
"tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
"name": "default"
},
"ip_protocol": null,
"to_port": null,
"parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450",
"ip_range": {},
"id": "bb3cc988-e06a-49f6-b668-600e8bf193ee"
},
{
"from_port": null,
"group": {
"tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
"name": "default"
},
"ip_protocol": null,
"to_port": null,
"parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450",
"ip_range": {},
"id": "f9371051-d7e1-4be4-8748-77b1e0913730"
}
],
"tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
"description": "default",
"id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450",
"name": "default"
},
{
"rules": [
{
"from_port": 200,
"group": {},
"ip_protocol": "tcp",
"to_port": 400,
"parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"id": "3330120d-bbd1-4a73-bda9-0196a84d5670"
},
{
"from_port": 201,
"group": {},
"ip_protocol": "tcp",
"to_port": 400,
"parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"id": "b550c9a6-970a-462d-984e-265e88020818"
}
],
"tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
"description": "desc-sg",
"id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5",
"name": "test-sg"
}
]
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_en-us_topic_0020212692_section22960139"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0090187679__en-us_topic_0057973221_en-us_topic_0020212692_p23670760">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0267427144.html">Security Group Management (OpenStack Nova APIs)</a></div>
</div>
</div>
View Git Blame Copy Permalink