vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpc/api-ref/vpc_sg01_0002.html
Qin Ying, Fan 310d2d9eb1 VPC API 20230106 version 
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>
2024-02-06 08:38:37 +00:00

293 lines
25 KiB
HTML
Raw Blame History

<a name="vpc_sg01_0002"></a><a name="vpc_sg01_0002"></a>
<h1 class="topictitle1">Querying Security Group Details</h1>
<div id="body28673382"><div class="section" id="vpc_sg01_0002__section183641929520"><h4 class="sectiontitle">Function</h4><p id="vpc_sg01_0002__p139990289520">This API is used to query details about a security group.</p>
</div>
<div class="section" id="vpc_sg01_0002__section383863439520"><h4 class="sectiontitle">URI</h4><p id="vpc_sg01_0002__p895811455523">GET /v1/{project_id}/security-groups/{security_group_id}</p>
<div class="p" id="vpc_sg01_0002__p7997127125616"><a href="#vpc_sg01_0002__table211310359520">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="vpc_sg01_0002__table211310359520"></a><a name="table211310359520"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_sg01_0002__table211310359520" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_sg01_0002__row27117139520"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpc_sg01_0002__p648001349520">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.2"><p id="vpc_sg01_0002__p477321789520">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.3"><p id="vpc_sg01_0002__p94870139520">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_sg01_0002__row81820489520"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpc_sg01_0002__p551819219520">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpc_sg01_0002__p419930979520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpc_sg01_0002__p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_sg01_0002__row610956059520"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpc_sg01_0002__p563498999520">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpc_sg01_0002__p577313839520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpc_sg01_0002__p482793239520">Specifies the security group ID, which uniquely identifies the security group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="vpc_sg01_0002__section166598629520"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_sg01_0002__p518422579520">None</p>
</div>
<div class="section" id="vpc_sg01_0002__section9694841121715"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_sg01_0002__screen32273037144016">GET https://{Endpoint}/v1/{project_id}/security-groups/16b6e77a-08fa-42c7-aa8b-106c048884e6</pre>
</div>
<div class="section" id="vpc_sg01_0002__section77135839520"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_sg01_0002__table421354429520" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_sg01_0002__row4869309520"><th align="left" class="cellrowborder" valign="top" width="23.26%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_sg01_0002__p436004679520">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.09%" id="mcps1.3.5.2.2.4.1.2"><p id="vpc_sg01_0002__p503805059520">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.65%" id="mcps1.3.5.2.2.4.1.3"><p id="vpc_sg01_0002__p31092159520">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_sg01_0002__row402360929520"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_sg01_0002__p563104169520">security_group</p>
</td>
<td class="cellrowborder" valign="top" width="22.09%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_sg01_0002__p192697131358"><a href="#vpc_sg01_0002__table333218689520">security_group</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="54.65%" headers="mcps1.3.5.2.2.4.1.3 "><p id="vpc_sg01_0002__p119580209520">Specifies the security group object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_sg01_0002__table333218689520"></a><a name="table333218689520"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_sg01_0002__table333218689520" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of <strong id="vpc_sg01_0002__b1747750399">security_group</strong> fields</caption><thead align="left"><tr id="vpc_sg01_0002__vpc_sg01_0001_row158029169489"><th align="left" class="cellrowborder" valign="top" width="34.52%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_sg01_0002__vpc_sg01_0001_p581966039489">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.45%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_sg01_0002__vpc_sg01_0001_p166624639489">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.03%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_sg01_0002__vpc_sg01_0001_p278965559489">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_sg01_0002__vpc_sg01_0001_row643785269489"><td class="cellrowborder" valign="top" width="34.52%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p329359299489">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p230963549489">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.03%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_sg01_0002__vpc_sg01_0001_p410063869489">Specifies the security group name.</p>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row32100149489"><td class="cellrowborder" valign="top" width="34.52%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p522665169489">description</p>
</td>
<td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p513285489489">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.03%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_sg01_0002__vpc_sg01_0001_p290727679489">Provides supplementary information about the security group.</p>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row639972559489"><td class="cellrowborder" valign="top" width="34.52%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p634276169489">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p114487449489">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.03%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_sg01_0002__vpc_sg01_0001_p259109349489">Specifies the security group ID, which uniquely identifies the security group.</p>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row422544629489"><td class="cellrowborder" valign="top" width="34.52%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p590727719489">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p10272179489">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.03%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_sg01_0002__vpc_sg01_0001_p303149719489">Specifies the resource ID of the VPC to which the security group belongs.</p>
<div class="note" id="vpc_sg01_0002__vpc_sg01_0001_note1071412434342"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpc_sg01_0002__p53351132589">Currently, this parameter is not recommended because it is only used as a prompt and does not restrict that the security group must be associated with the VPC.</p>
</div></div>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row30397199489"><td class="cellrowborder" valign="top" width="34.52%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p252491199489">security_group_rules</p>
</td>
<td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p193798449489">Array of <a href="#vpc_sg01_0002__table488727239520">security_group_rule</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="44.03%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_sg01_0002__vpc_sg01_0001_p643841019489">Specifies the default security group rules, which ensure that resources in the security group can communicate with one another.</p>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row104191723103213"><td class="cellrowborder" valign="top" width="34.52%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p19326142511323">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p203266259325">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.03%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul15517142134714"><li id="vpc_sg01_0002__vpc_sg01_0001_li051772118474">Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li15517102117473">The value is <strong id="vpc_sg01_0002__b238512144159">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value <strong id="vpc_sg01_0002__b78111295157">0</strong> indicates the default enterprise project.</li></ul>
<div class="note" id="vpc_sg01_0002__vpc_sg01_0001_note428720710014"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpc_sg01_0002__vpc_sg01_0001_vpc_api01_0001_p182751511487">This parameter is unsupported. Do not use it.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_sg01_0002__table488727239520"></a><a name="table488727239520"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_sg01_0002__table488727239520" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_sg01_0002__vpc_sg01_0001_b897031316622">security_group_rule</strong> objects</caption><thead align="left"><tr id="vpc_sg01_0002__vpc_sg01_0001_row611024789489"><th align="left" class="cellrowborder" valign="top" width="34.143414341434145%" id="mcps1.3.5.4.2.4.1.1"><p id="vpc_sg01_0002__vpc_sg01_0001_p98931099489">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.732073207320735%" id="mcps1.3.5.4.2.4.1.2"><p id="vpc_sg01_0002__vpc_sg01_0001_p368367439489">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.124512451245124%" id="mcps1.3.5.4.2.4.1.3"><p id="vpc_sg01_0002__vpc_sg01_0001_p23523719489">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_sg01_0002__vpc_sg01_0001_row397690789489"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p656951529489">id</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p307102169489">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_sg01_0002__vpc_sg01_0001_p216633359489">Specifies the security group rule ID, which uniquely identifies the security group rule.</p>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row2447898388"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p432391116381">description</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p20328111163813">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul12329121935111"><li id="vpc_sg01_0002__vpc_sg01_0001_li93276198510">Provides supplementary information about the security group rule.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li5329141955114">The value can contain no more than 255 characters, including letters and digits.</li></ul>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row320377939489"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p620577269489">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p644725909489">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_sg01_0002__vpc_sg01_0001_p260700169489">Specifies the security group rule ID, which uniquely identifies the security group rule.</p>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row602307149489"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p184092199489">direction</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p499849219489">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul8415142317513"><li id="vpc_sg01_0002__vpc_sg01_0001_li124154235511">Specifies the direction of access control.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li6916104173512">Possible values are as follows:<ul id="vpc_sg01_0002__vpc_sg01_0001_ul6968104419355"><li id="vpc_sg01_0002__vpc_sg01_0001_li2082844743512"><strong id="vpc_sg01_0002__vpc_sg01_0001_b96381611133314">egress</strong></li><li id="vpc_sg01_0002__vpc_sg01_0001_li1415123145113"><strong id="vpc_sg01_0002__vpc_sg01_0001_b9979172133411">ingress</strong></li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row53906049489"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p460392719489">ethertype</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p248464689489">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul78261926205119"><li id="vpc_sg01_0002__vpc_sg01_0001_li178263267515">Specifies the IP protocol version.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li1882682615114">The value can be <strong id="vpc_sg01_0002__vpc_sg01_0001_b18421041195618">IPv4</strong> or <strong id="vpc_sg01_0002__vpc_sg01_0001_b1284244110568">IPv6</strong>.</li></ul>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row619098859489"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p520137079489">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p17867349489">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul585593011517"><li id="vpc_sg01_0002__vpc_sg01_0001_li15855430185119">Specifies the protocol type.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li18254635105816">The value can be <strong id="vpc_sg01_0002__vpc_sg01_0001_b1576775584012">icmp</strong>, <strong id="vpc_sg01_0002__vpc_sg01_0001_b20767455104015">tcp</strong>, <strong id="vpc_sg01_0002__vpc_sg01_0001_b1876714558408">udp</strong>, or an IP protocol number (0 to 255, for example, 47 for GRE)</li><li id="vpc_sg01_0002__vpc_sg01_0001_li14855183045113">If the parameter is left blank, all protocols are supported.</li></ul>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row29885099489"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p424368709489">port_range_min</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p167549899489">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul1445493595119"><li id="vpc_sg01_0002__vpc_sg01_0001_li164541435125119">Specifies the start port number.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li1454635135113">The value ranges from 1 to 65535.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li1845415357516">The value cannot be greater than the <strong id="vpc_sg01_0002__vpc_sg01_0001_b842352706195750">port_range_max</strong> value. An empty value indicates all ports. If the protocol is <strong id="vpc_sg01_0002__vpc_sg01_0001_b842352706195910">icmp</strong>, the value range is shown in <a href="vpc_api_0009.html">ICMP-Port Range Relationship Table</a>.</li></ul>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row330228649489"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p239666849489">port_range_max</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p641378179489">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul23372407514"><li id="vpc_sg01_0002__vpc_sg01_0001_li233744065111">Specifies the end port number.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li933764019519">The value ranges from 1 to 65535.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li133371240165111">If the protocol is not <strong id="vpc_sg01_0002__vpc_sg01_0001_b842352706195730">icmp</strong>, the value cannot be smaller than the <strong id="vpc_sg01_0002__vpc_sg01_0001_b873792704">port_range_min</strong> value. An empty value indicates all ports. If the protocol is <strong id="vpc_sg01_0002__vpc_sg01_0001_b2077102465">icmp</strong>, the value range is shown in <a href="vpc_api_0009.html">ICMP-Port Range Relationship Table</a>.</li></ul>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row1745649489"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p144166029489">remote_ip_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p139601239489">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul42481344125119"><li id="vpc_sg01_0002__vpc_sg01_0001_li1424824420511">Specifies the remote IP address. If the access control direction is set to <strong id="vpc_sg01_0002__vpc_sg01_0001_b168443017227">egress</strong>, the parameter specifies the source IP address. If the access control direction is set to <strong id="vpc_sg01_0002__vpc_sg01_0001_b138411307223">ingress</strong>, the parameter specifies the destination IP address.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li2248184413517">The value can be in the CIDR format or IP addresses.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li9248644125119">The parameter is mutually exclusive with parameter <strong id="vpc_sg01_0002__vpc_sg01_0001_b286230152212">remote_group_id</strong>.</li></ul>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row436879079489"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p420105089489">remote_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p465213149489">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul12672447145118"><li id="vpc_sg01_0002__vpc_sg01_0001_li167216475516">Specifies the ID of the peer security group.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li20672147185110">The value is mutually exclusive with parameter <strong id="vpc_sg01_0002__vpc_sg01_0001_b28793017228">remote_ip_prefix</strong>.</li></ul>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row73928331228"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p1146204615214">remote_address_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p3469461328">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul967819571421"><li id="vpc_sg01_0002__vpc_sg01_0001_li106781571627">Specifies the remote IP address group ID.</li><li id="vpc_sg01_0002__vpc_sg01_0001_li767815571025">The value is mutually exclusive with parameters <strong id="vpc_sg01_0002__vpc_sg01_0001_b1185142797">remote_ip_prefix</strong> and <strong id="vpc_sg01_0002__vpc_sg01_0001_b64611932598">remote_group_id</strong>.</li></ul>
</td>
</tr>
<tr id="vpc_sg01_0002__vpc_sg01_0001_row66316933510"><td class="cellrowborder" valign="top" width="34.143414341434145%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_sg01_0002__vpc_sg01_0001_p66339133513">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.732073207320735%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_sg01_0002__vpc_sg01_0001_p383982443618">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.124512451245124%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_sg01_0002__vpc_sg01_0001_ul5694239163714"><li id="vpc_sg01_0002__vpc_sg01_0001_li1369413919374">Specifies the ID of the project to which the security group rule belongs.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_sg01_0002__section174908381819"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_sg01_0002__screen751137092615">{
"security_group": {
"id": "16b6e77a-08fa-42c7-aa8b-106c048884e6",
"name": "qq",
"description": "qq",
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
"enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
"security_group_rules": [
{
"id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80",
"tenant_id": "060576782980d5762f9ec014dd2f1148",
"security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325",
"remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325",
"direction": "ingress",
"protocol": null,
"description": "",
"ethertype": "IPv6",
"remote_ip_prefix": null,
"remote_address_group_id": null,
"port_range_max": null,
"port_range_min": null
},
{
"id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677",
"tenant_id": "060576782980d5762f9ec014dd2f1148",
"security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325",
"remote_group_id": null,
"direction": "egress",
"protocol": null,
"description": "",
"ethertype": "IPv6",
"remote_ip_prefix": null,
"remote_address_group_id": null,
"port_range_max": null,
"port_range_min": null
},
{
"id": "9581f18c-1fdd-43da-ace9-7758a56ef28a",
"tenant_id": "060576782980d5762f9ec014dd2f1148",
"security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325",
"remote_group_id": null,
"direction": "egress",
"protocol": null,
"description": "",
"ethertype": "IPv4",
"remote_ip_prefix": null,
"remote_address_group_id": null,
"port_range_max": null,
"port_range_min": null
},
{
"id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8",
"tenant_id": "060576782980d5762f9ec014dd2f1148",
"security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325",
"remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325",
"direction": "ingress",
"protocol": null,
"description": "",
"ethertype": "IPv4",
"remote_ip_prefix": null,
"remote_address_group_id": null,
"port_range_max": null,
"port_range_min": null
}
]
}
}</pre>
</div>
<div class="section" id="vpc_sg01_0002__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_sg01_0002__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_sg01_0002__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_sg01_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_sg01_0000.html">Security Group</a></div>
</div>
</div>
View Git Blame Copy Permalink