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_0065817702.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

339 lines
29 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0065817702"></a><a name="EN-US_TOPIC_0065817702"></a>
<h1 class="topictitle1">Querying Security Groups of a Specified <span id="text1326143054712">ECS</span></h1>
<div id="body1499652824861"><div class="section" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_section55261147"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p18476557">This API is used to query security groups of a specified <span id="EN-US_TOPIC_0065817702__text2071520141416">ECS</span>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_section27588283"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p17816132418199">GET /v2.1/{project_id}/servers/{server_id}/os-security-groups</p>
<p id="EN-US_TOPIC_0065817702__p9964181844014">GET /v2/{project_id}/servers/{server_id}/os-security-groups</p>
<div class="p" id="EN-US_TOPIC_0065817702__p1786641963811"><a href="#EN-US_TOPIC_0065817702__en-us_topic_0057972666_table32475667">Table 1</a> describes the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table32475667"></a><a name="en-us_topic_0057972666_table32475667"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table32475667" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row44937496"><th align="left" class="cellrowborder" valign="top" width="22.24%" id="mcps1.3.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0065817702__p5187119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.87%" id="mcps1.3.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0065817702__p17503500">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.88999999999999%" id="mcps1.3.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0065817702__p8497414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row1664874"><td class="cellrowborder" valign="top" width="22.24%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p637140">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p51608407">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.88999999999999%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817702__p37593705">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row41565035"><td class="cellrowborder" valign="top" width="22.24%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p11324657">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p44882061">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.88999999999999%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p11568292">Specifies the <span id="EN-US_TOPIC_0065817702__text1018234917554">ECS</span> ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_section20058459"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p96118523339">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_section46308405"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065817702__p36561745183818"><a href="#EN-US_TOPIC_0065817702__en-us_topic_0057972666_table35383970">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table35383970"></a><a name="en-us_topic_0057972666_table35383970"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table35383970" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row64935954"><th align="left" class="cellrowborder" valign="top" width="20.88791120887911%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0065817702__en-us_topic_0058745339_p39560242204918">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.918508149185081%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0065817702__p85762038122710">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.28817118288171%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0065817702__en-us_topic_0058745339_p50263001204918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.9054094590541%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0065817702__en-us_topic_0058745339_p2596798204918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row55059565"><td class="cellrowborder" valign="top" width="20.88791120887911%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p30639779">security_groups</p>
<p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p7322556"></p>
</td>
<td class="cellrowborder" valign="top" width="14.918508149185081%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__p55769386272">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.28817118288171%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p56256135">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="45.9054094590541%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p64862199">Specifies security groups. For details, see <a href="#EN-US_TOPIC_0065817702__en-us_topic_0057972666_table19346796">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table19346796"></a><a name="en-us_topic_0057972666_table19346796"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table19346796" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b897031316622">security_group</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row58796306"><th align="left" class="cellrowborder" valign="top" width="20.89%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0065817702__p827545914121">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.92%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0065817702__p11432184172710">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.29%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0065817702__p82751759181214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.9%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0065817702__p127545951215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row57297510"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p10586695">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.92%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__p1243284132717">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.29%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p843319816231">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.9%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p65280430">Specifies information about a security group. It must contain 0 to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row50652963"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p9249362">id</p>
</td>
<td class="cellrowborder" valign="top" width="14.92%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__p1143318416271">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.29%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p4089483316231">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.9%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p34571641">Specifies the security group ID in UUID format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row42709316"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p36902586">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.92%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__p174331541152718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.29%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p1599788116231">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.9%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p55752527">Specifies the security group name. It must contain 0 to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row32010697"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p42729680">rules</p>
</td>
<td class="cellrowborder" valign="top" width="14.92%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__p104333410271">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.29%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p5262223416231">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="45.9%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p6918001">Specifies security group rules. For details, see <a href="#EN-US_TOPIC_0065817702__en-us_topic_0057972666_table44319244">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row62262011"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p10058158">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.92%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__p1443354112276">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.29%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p4244727716231">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.9%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p29544808">Specifies the tenant or project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table44319244"></a><a name="en-us_topic_0057972666_table44319244"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table44319244" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0065817702__b842855430">security_group_rule</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row251973"><th align="left" class="cellrowborder" valign="top" width="20.4020402040204%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0065817702__p0721526137">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.8015801580158%" id="mcps1.3.4.5.2.5.1.2"><p id="EN-US_TOPIC_0065817702__p5738162171319">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.89178917891789%" id="mcps1.3.4.5.2.5.1.3"><p id="EN-US_TOPIC_0065817702__p157217213133">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.904590459045906%" id="mcps1.3.4.5.2.5.1.4"><p id="EN-US_TOPIC_0065817702__p9738112141316">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row7290082"><td class="cellrowborder" valign="top" width="20.4020402040204%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p13853807162318">parent_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p29429676162318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p48416589162318">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.904590459045906%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p34993588162318">Specifies the associated security group ID in UUID format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row34897438"><td class="cellrowborder" valign="top" width="20.4020402040204%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p8957549162318">ip_protocol</p>
</td>
<td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p50228537162318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p54472897162318">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.904590459045906%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p41979710162318">Specifies the protocol type or the IP protocol number. The value can be <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b84235270618469">icmp</strong>, <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b84235270619548">tcp</strong>, <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b842352706184613">udp</strong>, or the IP protocol number.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row7551780"><td class="cellrowborder" valign="top" width="20.4020402040204%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p1566835162318">from_port</p>
</td>
<td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p12349793162318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p59804790162318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.904590459045906%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p6565245172437">Specifies the start port number. The value ranges from 1 to 65,535 and cannot be greater than <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b84235270692028">to_port</strong>.</p>
<p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p60809181162318">When <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b842352706184658">ip_protocol</strong> is <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b84235270618473">icmp</strong>, this parameter specifies a port type with a length from 0 to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row63246244"><td class="cellrowborder" valign="top" width="20.4020402040204%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p38043040162318">to_port</p>
</td>
<td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p22525157162318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p61587420162318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.904590459045906%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p4318355217257">Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than <strong id="EN-US_TOPIC_0065817702__b819372184">from_port</strong>.</p>
<p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p12598434162318">When <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b842352706162939">ip_protocol</strong> is <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b842352706162947">icmp</strong>, it specifies the code. The value ranges from 0 to 255. If both <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b842352706163018">from_port</strong> and <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b842352706163116">to_port</strong> are <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b842352706163025">-1</strong>, any ICMP packet can be transmitted.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row26059286"><td class="cellrowborder" valign="top" width="20.4020402040204%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p57453407162318">ip_range</p>
</td>
<td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p1316814162318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p23214382162318">Object</p>
</td>
<td class="cellrowborder" valign="top" width="45.904590459045906%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p34680534172630">Specifies the peer IP segment in CIDR format. For details, see <a href="#EN-US_TOPIC_0065817702__en-us_topic_0057972666_table4101480163218">Table 5</a>.</p>
<p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p39553127162318">The value of <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b84235270618494">ip_range</strong> or <strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b84235270618498">group</strong> must be empty.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row25228285"><td class="cellrowborder" valign="top" width="20.4020402040204%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p44527008162318">group</p>
</td>
<td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p16815533162318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p49917868162318">Object</p>
</td>
<td class="cellrowborder" valign="top" width="45.904590459045906%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p58652843172711">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_0065817702__en-us_topic_0057972666_table9527961163416">Table 6</a>.</p>
<p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p19880971162318">The value of <strong id="EN-US_TOPIC_0065817702__b1346158312">ip_range</strong> or <strong id="EN-US_TOPIC_0065817702__b518862994">group</strong> must be empty.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row6587426"><td class="cellrowborder" valign="top" width="20.4020402040204%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p64822556162318">id</p>
</td>
<td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p31919068162318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p16135647162318">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.904590459045906%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p35307705162318">Specifies the security group rule ID in UUID format.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table4101480163218"></a><a name="en-us_topic_0057972666_table4101480163218"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table4101480163218" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="EN-US_TOPIC_0065817702__b1655221598">ip_range</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row55642344163218"><th align="left" class="cellrowborder" valign="top" width="20.890000000000004%" id="mcps1.3.4.6.2.5.1.1"><p id="EN-US_TOPIC_0065817702__p87155671318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.360000000000001%" id="mcps1.3.4.6.2.5.1.2"><p id="EN-US_TOPIC_0065817702__p13333193072819">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.140000000000004%" id="mcps1.3.4.6.2.5.1.3"><p id="EN-US_TOPIC_0065817702__p147151661134">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.61000000000001%" id="mcps1.3.4.6.2.5.1.4"><p id="EN-US_TOPIC_0065817702__p0715569135">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row5649056163218"><td class="cellrowborder" valign="top" width="20.890000000000004%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p54920430163218">cidr</p>
</td>
<td class="cellrowborder" valign="top" width="15.360000000000001%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__p1133333018288">No</p>
</td>
<td class="cellrowborder" valign="top" width="27.140000000000004%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p19369856163218">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.61000000000001%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p48550802163218">Specifies the peer IP segment in CIDR format.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table9527961163416"></a><a name="en-us_topic_0057972666_table9527961163416"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_table9527961163416" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_b842352706185646">group</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row57542164163416"><th align="left" class="cellrowborder" valign="top" width="20.330000000000002%" id="mcps1.3.4.7.2.5.1.1"><p id="EN-US_TOPIC_0065817702__p478979121310">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.559999999999999%" id="mcps1.3.4.7.2.5.1.2"><p id="EN-US_TOPIC_0065817702__p528573382814">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.86%" id="mcps1.3.4.7.2.5.1.3"><p id="EN-US_TOPIC_0065817702__p1178918914133">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.25%" id="mcps1.3.4.7.2.5.1.4"><p id="EN-US_TOPIC_0065817702__p878949121318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row46600064163416"><td class="cellrowborder" valign="top" width="20.330000000000002%" headers="mcps1.3.4.7.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p16508853163416">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.559999999999999%" headers="mcps1.3.4.7.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__p14286233132819">No</p>
</td>
<td class="cellrowborder" valign="top" width="26.86%" headers="mcps1.3.4.7.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p62148702163416">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.25%" headers="mcps1.3.4.7.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p4179246163416">Specifies the ID of the tenant of the peer security group.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_row37613216163416"><td class="cellrowborder" valign="top" width="20.330000000000002%" headers="mcps1.3.4.7.2.5.1.1 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p26771660163416">name</p>
</td>
<td class="cellrowborder" valign="top" width="15.559999999999999%" headers="mcps1.3.4.7.2.5.1.2 "><p id="EN-US_TOPIC_0065817702__p7286113310285">No</p>
</td>
<td class="cellrowborder" valign="top" width="26.86%" headers="mcps1.3.4.7.2.5.1.3 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p21020848163416">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.25%" headers="mcps1.3.4.7.2.5.1.4 "><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_p9073859163416">Specifies the name of the peer security group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_section14122463"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0065817702__p2771134211513">Query security groups of a specified ECS.</p>
<pre class="screen" id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_screen27978103">GET https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/servers/65fae4c2-3a09-46c6-af12-3b04f1fdba1e/os-security-groups
GET https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/servers/65fae4c2-3a09-46c6-af12-3b04f1fdba1e/os-security-groups</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065817702__section1507145117257"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065817702__screen553345182513">{
"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_0065817702__en-us_topic_0057972666_section1642564"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065817702__en-us_topic_0057972666_en-us_topic_0020212652_p5882489">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_0031167514.html">Security Group Management</a></div>
</div>
</div>
View Git Blame Copy Permalink