yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/vpc/api-ref/vpc_apiv3_0016.html
fanqinying 05458809ab VPC API 20250121 version 
Reviewed-by: Szirovicza Gergő <a94652429@noreply.gitea.eco.tsi-dev.otc-service.com>
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2025-09-11 14:33:55 +00:00

572 lines
56 KiB
HTML
Raw Blame History

<a name="vpc_apiv3_0016"></a><a name="vpc_apiv3_0016"></a>
<h1 class="topictitle1">Creating a Security Group Rule</h1>
<div id="body1708331107508"><div class="section" id="vpc_apiv3_0016__section5819322585"><h4 class="sectiontitle">Function</h4><p id="vpc_apiv3_0016__p0819822689">A security group has inbound and outbound rules to control traffic that is allowed to reach or leave the instances associated with the security group.</p>
</div>
<div class="section" id="vpc_apiv3_0016__section1382018221684"><h4 class="sectiontitle">URI</h4><p id="vpc_apiv3_0016__p482011221085">POST /v3/{project_id}/vpc/security-group-rules</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0016__table128202221085" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="vpc_apiv3_0016__row1282013221681"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="vpc_apiv3_0016__p198207225815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="vpc_apiv3_0016__p20820122483">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="vpc_apiv3_0016__p1482117225819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="vpc_apiv3_0016__p1082112229813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0016__row98201221089"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="vpc_apiv3_0016__p682114221181">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="vpc_apiv3_0016__p1582119229813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="vpc_apiv3_0016__p17821202220814">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul188217226820"><li id="vpc_apiv3_0016__li1821112216817"><p id="vpc_apiv3_0016__p182111221281"><a name="vpc_apiv3_0016__li1821112216817"></a><a name="li1821112216817"></a>Definition: ID of the project that a security group rule belongs to.</p>
</li><li id="vpc_apiv3_0016__li178217220814"><p id="vpc_apiv3_0016__p48219229810"><a name="vpc_apiv3_0016__li178217220814"></a><a name="li178217220814"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0016__section1682117221689"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0016__request_CreateSecurityGroupRuleRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="vpc_apiv3_0016__row682114227812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="vpc_apiv3_0016__p58224221583">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="vpc_apiv3_0016__p3822112219818">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="vpc_apiv3_0016__p108221822883">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="vpc_apiv3_0016__p1682216221787">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0016__row982117221819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="vpc_apiv3_0016__p782211227817">dry_run</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="vpc_apiv3_0016__p1582219223814">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="vpc_apiv3_0016__p10822422780">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><ul id="vpc_apiv3_0016__ul1482212225811"><li id="vpc_apiv3_0016__li118228229819"><p id="vpc_apiv3_0016__p198227221484"><a name="vpc_apiv3_0016__li118228229819"></a><a name="li118228229819"></a>Definition: Whether to only send the check request.</p>
</li><li id="vpc_apiv3_0016__li7822142210810"><p id="vpc_apiv3_0016__p2822152214811"><a name="vpc_apiv3_0016__li7822142210810"></a><a name="li7822142210810"></a>Constraints: None</p>
</li><li id="vpc_apiv3_0016__li982216225813"><p id="vpc_apiv3_0016__p20822162210816"><a name="vpc_apiv3_0016__li982216225813"></a><a name="li982216225813"></a>Range:</p>
<ul id="vpc_apiv3_0016__ul168224222811"><li id="vpc_apiv3_0016__li1082218221380"><p id="vpc_apiv3_0016__p10822102217819"><a name="vpc_apiv3_0016__li1082218221380"></a><a name="li1082218221380"></a><strong id="vpc_apiv3_0016__b382220221187">true</strong>: A check request will be sent and no security group rule will be created. Check items include mandatory parameters, request format, and constraints. If the check fails, an error will be returned. If the check succeeds, response code 202 will be returned.</p>
</li><li id="vpc_apiv3_0016__li6822722187"><p id="vpc_apiv3_0016__p178223223817"><a name="vpc_apiv3_0016__li6822722187"></a><a name="li6822722187"></a><strong id="vpc_apiv3_0016__b182218226819">false</strong>: A request will be sent and a security group rule will be created.</p>
</li></ul>
</li><li id="vpc_apiv3_0016__li182372220812"><p id="vpc_apiv3_0016__p12823122220811"><a name="vpc_apiv3_0016__li182372220812"></a><a name="li182372220812"></a>Default Value: <strong id="vpc_apiv3_0016__b168236226818">false</strong></p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row58212221286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="vpc_apiv3_0016__p5823922688">security_group_rule</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="vpc_apiv3_0016__p2823182213815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="vpc_apiv3_0016__p198231221181"><a href="#vpc_apiv3_0016__request_CreateSecurityGroupRuleOption">CreateSecurityGroupRuleOption</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><ul id="vpc_apiv3_0016__ul1582310220816"><li id="vpc_apiv3_0016__li1682313223814"><p id="vpc_apiv3_0016__p128239222812"><a name="vpc_apiv3_0016__li1682313223814"></a><a name="li1682313223814"></a>Definition: Request body for creating a security group rule.</p>
</li><li id="vpc_apiv3_0016__li482310227818"><p id="vpc_apiv3_0016__p88235225814"><a name="vpc_apiv3_0016__li482310227818"></a><a name="li482310227818"></a>Constraints: None</p>
</li><li id="vpc_apiv3_0016__li2823322480"><p id="vpc_apiv3_0016__p178231222487"><a name="vpc_apiv3_0016__li2823322480"></a><a name="li2823322480"></a>Range: None</p>
</li><li id="vpc_apiv3_0016__li198231322982"><p id="vpc_apiv3_0016__p1282311226818"><a name="vpc_apiv3_0016__li198231322982"></a><a name="li198231322982"></a>Default Value: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0016__request_CreateSecurityGroupRuleOption"></a><a name="request_CreateSecurityGroupRuleOption"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0016__request_CreateSecurityGroupRuleOption" frame="border" border="1" rules="all"><caption><b>Table 3 </b>CreateSecurityGroupRuleOption</caption><thead align="left"><tr id="vpc_apiv3_0016__row17823172210810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="vpc_apiv3_0016__p48241222819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="vpc_apiv3_0016__p082418221484">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="vpc_apiv3_0016__p5824112219819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="vpc_apiv3_0016__p282552214818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0016__row38248221188"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p168257222816">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p78250221383">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p78251122582">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul1682514226820"><li id="vpc_apiv3_0016__li1582512226816"><p id="vpc_apiv3_0016__p14825622384"><a name="vpc_apiv3_0016__li1582512226816"></a><a name="li1582512226816"></a>Definition: ID of the security group that a security group rule belongs to.</p>
</li><li id="vpc_apiv3_0016__li28255229817"><p id="vpc_apiv3_0016__p28254221886"><a name="vpc_apiv3_0016__li28255229817"></a><a name="li28255229817"></a>Constraints: None</p>
</li><li id="vpc_apiv3_0016__li582562216812"><p id="vpc_apiv3_0016__p78251922880"><a name="vpc_apiv3_0016__li582562216812"></a><a name="li582562216812"></a>Range: None</p>
</li><li id="vpc_apiv3_0016__li88269221086"><p id="vpc_apiv3_0016__p108261022484"><a name="vpc_apiv3_0016__li88269221086"></a><a name="li88269221086"></a>Default Value: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row782413221484"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p682613221583">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p208262022180">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p1582662211818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul582610221813"><li id="vpc_apiv3_0016__li18261622588"><p id="vpc_apiv3_0016__p198261122181"><a name="vpc_apiv3_0016__li18261622588"></a><a name="li18261622588"></a>Definition: Description of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li10826622085"><p id="vpc_apiv3_0016__p482613222813"><a name="vpc_apiv3_0016__li10826622085"></a><a name="li10826622085"></a>Constraints: The value can contain no more than 255 characters and cannot contain angle brackets (&lt; or &gt;).</p>
</li><li id="vpc_apiv3_0016__li1882652210819"><p id="vpc_apiv3_0016__p1782662216819"><a name="vpc_apiv3_0016__li1882652210819"></a><a name="li1882652210819"></a>Range: None</p>
</li><li id="vpc_apiv3_0016__li1482619225814"><p id="vpc_apiv3_0016__p13826202215818"><a name="vpc_apiv3_0016__li1482619225814"></a><a name="li1482619225814"></a>Default Value: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row128241622581"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p1382612218817">direction</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p19826172212814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p1382692220812">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul082622210820"><li id="vpc_apiv3_0016__li148269221385"><p id="vpc_apiv3_0016__p982619221889"><a name="vpc_apiv3_0016__li148269221385"></a><a name="li148269221385"></a>Definition: Inbound or outbound direction of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li1482616223819"><p id="vpc_apiv3_0016__p3827102218811"><a name="vpc_apiv3_0016__li1482616223819"></a><a name="li1482616223819"></a>Constraints: None</p>
</li><li id="vpc_apiv3_0016__li58271422088"><p id="vpc_apiv3_0016__p14827522481"><a name="vpc_apiv3_0016__li58271422088"></a><a name="li58271422088"></a>Range:</p>
<ul id="vpc_apiv3_0016__ul78275221580"><li id="vpc_apiv3_0016__li148274224814"><p id="vpc_apiv3_0016__p13827122210810"><a name="vpc_apiv3_0016__li148274224814"></a><a name="li148274224814"></a><strong id="vpc_apiv3_0016__b1582719228814">ingress</strong>: inbound direction</p>
</li><li id="vpc_apiv3_0016__li2827022088"><p id="vpc_apiv3_0016__p1182722213815"><a name="vpc_apiv3_0016__li2827022088"></a><a name="li2827022088"></a><strong id="vpc_apiv3_0016__b78271622480">egress</strong>: outbound direction</p>
</li></ul>
</li><li id="vpc_apiv3_0016__li182712211815"><p id="vpc_apiv3_0016__p1182715222084"><a name="vpc_apiv3_0016__li182712211815"></a><a name="li182712211815"></a>Default Value: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row78240223814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p11827122284">ethertype</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p1082716221184">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p682792218813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul18279227820"><li id="vpc_apiv3_0016__li10827122215817"><p id="vpc_apiv3_0016__p58271322285"><a name="vpc_apiv3_0016__li10827122215817"></a><a name="li10827122215817"></a>Definition: IP address version of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li1082712221384"><p id="vpc_apiv3_0016__p148279227814"><a name="vpc_apiv3_0016__li1082712221384"></a><a name="li1082712221384"></a>Constraints: None</p>
</li><li id="vpc_apiv3_0016__li78271225814"><p id="vpc_apiv3_0016__p982712221683"><a name="vpc_apiv3_0016__li78271225814"></a><a name="li78271225814"></a>Range:</p>
<ul id="vpc_apiv3_0016__ul138279229815"><li id="vpc_apiv3_0016__li4827162213815"><p id="vpc_apiv3_0016__p282718221782"><a name="vpc_apiv3_0016__li4827162213815"></a><a name="li4827162213815"></a>IPv4</p>
</li><li id="vpc_apiv3_0016__li682718221184"><p id="vpc_apiv3_0016__p12827162212815"><a name="vpc_apiv3_0016__li682718221184"></a><a name="li682718221184"></a>IPv6</p>
</li></ul>
</li><li id="vpc_apiv3_0016__li68273222089"><p id="vpc_apiv3_0016__p18275226811"><a name="vpc_apiv3_0016__li68273222089"></a><a name="li68273222089"></a>Default Value: IPv4</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row188249226819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p282812221888">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p98284221186">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p582813221085">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul10828202217816"><li id="vpc_apiv3_0016__li7828182211817"><p id="vpc_apiv3_0016__p168288221387"><a name="vpc_apiv3_0016__li7828182211817"></a><a name="li7828182211817"></a>Definition: Communication protocol of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li17828162212815"><p id="vpc_apiv3_0016__p68284226817"><a name="vpc_apiv3_0016__li17828162212815"></a><a name="li17828162212815"></a>Constraints:</p>
<ul id="vpc_apiv3_0016__ul1828122211817"><li id="vpc_apiv3_0016__li6828202214815"><p id="vpc_apiv3_0016__p8828122185"><a name="vpc_apiv3_0016__li6828202214815"></a><a name="li6828202214815"></a>If the parameter is left blank, all protocols are supported.</p>
</li><li id="vpc_apiv3_0016__li1282822214815"><p id="vpc_apiv3_0016__p1382815221681"><a name="vpc_apiv3_0016__li1282822214815"></a><a name="li1282822214815"></a>If the protocol is <strong id="vpc_apiv3_0016__b128281322589">icmpv6</strong>, IP version should be IPv6.</p>
</li><li id="vpc_apiv3_0016__li582817221489"><p id="vpc_apiv3_0016__p2828222385"><a name="vpc_apiv3_0016__li582817221489"></a><a name="li582817221489"></a>If the protocol is <strong id="vpc_apiv3_0016__b082818224816">icmp</strong>, IP version should be IPv4.</p>
</li></ul>
</li><li id="vpc_apiv3_0016__li13828112213813"><p id="vpc_apiv3_0016__p1682818222818"><a name="vpc_apiv3_0016__li13828112213813"></a><a name="li13828112213813"></a>Range:</p>
<ul id="vpc_apiv3_0016__ul2082813221786"><li id="vpc_apiv3_0016__li782832210814"><p id="vpc_apiv3_0016__p08280221085"><a name="vpc_apiv3_0016__li782832210814"></a><a name="li782832210814"></a><strong id="vpc_apiv3_0016__b13828142211817">icmp</strong></p>
</li><li id="vpc_apiv3_0016__li1982882218817"><p id="vpc_apiv3_0016__p1982810221586"><a name="vpc_apiv3_0016__li1982882218817"></a><a name="li1982882218817"></a><strong id="vpc_apiv3_0016__b78281922684">tcp</strong></p>
</li><li id="vpc_apiv3_0016__li682811221282"><p id="vpc_apiv3_0016__p148281322984"><a name="vpc_apiv3_0016__li682811221282"></a><a name="li682811221282"></a><strong id="vpc_apiv3_0016__b382852219815">udp</strong></p>
</li><li id="vpc_apiv3_0016__li1482818221689"><p id="vpc_apiv3_0016__p18282226811"><a name="vpc_apiv3_0016__li1482818221689"></a><a name="li1482818221689"></a><strong id="vpc_apiv3_0016__b182852212814">icmpv6</strong></p>
</li><li id="vpc_apiv3_0016__li198282225813"><p id="vpc_apiv3_0016__p14829132217818"><a name="vpc_apiv3_0016__li198282225813"></a><a name="li198282225813"></a>IP protocol number (0-255)</p>
</li></ul>
</li><li id="vpc_apiv3_0016__li28295221184"><p id="vpc_apiv3_0016__p6829522182"><a name="vpc_apiv3_0016__li28295221184"></a><a name="li28295221184"></a>Default Value: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row0824132215810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p1082918221818">multiport</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p1382912212817">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p178293221814">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul382917221187"><li id="vpc_apiv3_0016__li682913223819"><p id="vpc_apiv3_0016__p0829172214819"><a name="vpc_apiv3_0016__li682913223819"></a><a name="li682913223819"></a>Definition: Port range of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li108291522681"><p id="vpc_apiv3_0016__p482916221686"><a name="vpc_apiv3_0016__li108291522681"></a><a name="li108291522681"></a>Constraints: The port number ranges from 1 to 65535.</p>
</li><li id="vpc_apiv3_0016__li118299221182"><p id="vpc_apiv3_0016__p1082913226818"><a name="vpc_apiv3_0016__li118299221182"></a><a name="li118299221182"></a>Range: The value can be a single port (80), a port range (1-30), or inconsecutive ports separated by commas (22,3389,80).</p>
</li><li id="vpc_apiv3_0016__li198291922881"><p id="vpc_apiv3_0016__p68293228811"><a name="vpc_apiv3_0016__li198291922881"></a><a name="li198291922881"></a>Default Value: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row1082414228811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p158293222085">remote_ip_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p88291122580">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p148299223819">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul10829922289"><li id="vpc_apiv3_0016__li0829102214819"><p id="vpc_apiv3_0016__p1682982211812"><a name="vpc_apiv3_0016__li0829102214819"></a><a name="li0829102214819"></a>Definition: Remote IP address of a security group rule. If direction is set to <strong id="vpc_apiv3_0016__b15829822987">egress</strong>, this address is the outbound destination and will be accessed by instances in the security group. If direction is set to <strong id="vpc_apiv3_0016__b182911221588">ingress</strong>, this address is the inbound source and will access instances in the security group.</p>
</li><li id="vpc_apiv3_0016__li1882919221687"><p id="vpc_apiv3_0016__p78291422984"><a name="vpc_apiv3_0016__li1882919221687"></a><a name="li1882919221687"></a>Constraints:</p>
</li><li id="vpc_apiv3_0016__li108301722788"><p id="vpc_apiv3_0016__p16830122480"><a name="vpc_apiv3_0016__li108301722788"></a><a name="li108301722788"></a>This parameter is mutually exclusive with parameters <strong id="vpc_apiv3_0016__b10190221202814">remote_group_id</strong> and <strong id="vpc_apiv3_0016__b719012210285">remote_address_group_id</strong>.</p>
<ul id="vpc_apiv3_0016__ul1083072220816"><li id="vpc_apiv3_0016__li1783016222086"><p id="vpc_apiv3_0016__p1683032214810"><a name="vpc_apiv3_0016__li1783016222086"></a><a name="li1783016222086"></a>If this parameter is left blank, traffic from all remote IP addresses is allowed when the action of the rule is <strong id="vpc_apiv3_0016__b1283012217817">allow</strong>, and is denied when the action of the rule is <strong id="vpc_apiv3_0016__b1983011221811">deny</strong>.</p>
</li></ul>
</li><li id="vpc_apiv3_0016__li10830152219811"><p id="vpc_apiv3_0016__p1883018221080"><a name="vpc_apiv3_0016__li10830152219811"></a><a name="li10830152219811"></a>Range:</p>
<ul id="vpc_apiv3_0016__ul138306221389"><li id="vpc_apiv3_0016__li38301122789"><p id="vpc_apiv3_0016__p168309225814"><a name="vpc_apiv3_0016__li38301122789"></a><a name="li38301122789"></a>IP address. If an IP address is transferred in the request, the IP address is automatically formatted with /32 as the subnet mask, for example, 192.168.21.45/32.</p>
</li><li id="vpc_apiv3_0016__li983012217819"><p id="vpc_apiv3_0016__p8830162211813"><a name="vpc_apiv3_0016__li983012217819"></a><a name="li983012217819"></a>The value must be in CIDR format.</p>
</li></ul>
</li><li id="vpc_apiv3_0016__li5830422884"><p id="vpc_apiv3_0016__p11830102212810"><a name="vpc_apiv3_0016__li5830422884"></a><a name="li5830422884"></a>Default Value: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row782411223817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p18301922587">remote_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p1483013221385">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p108301722289">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul128304224814"><li id="vpc_apiv3_0016__li2830922182"><p id="vpc_apiv3_0016__p11830922283"><a name="vpc_apiv3_0016__li2830922182"></a><a name="li2830922182"></a>Definition: ID of the remote security group of a security group rule. If the action of the rule is <strong id="vpc_apiv3_0016__b483019225810">allow</strong>, the traffic from the remote security group is allowed. If the action of the rule is <strong id="vpc_apiv3_0016__b1830132217817">deny</strong>, the traffic from the remote security group is denied.</p>
</li><li id="vpc_apiv3_0016__li68305221887"><p id="vpc_apiv3_0016__p5830922884"><a name="vpc_apiv3_0016__li68305221887"></a><a name="li68305221887"></a>Constraints: This parameter is mutually exclusive with parameters <strong id="vpc_apiv3_0016__b10191321112811">remote_ip_prefix</strong> and <strong id="vpc_apiv3_0016__b4191162122818">remote_address_group_id</strong>.</p>
</li><li id="vpc_apiv3_0016__li2830422785"><p id="vpc_apiv3_0016__p178305221786"><a name="vpc_apiv3_0016__li2830422785"></a><a name="li2830422785"></a>Range: ID of an existing security group.</p>
</li><li id="vpc_apiv3_0016__li148301022882"><p id="vpc_apiv3_0016__p88307226812"><a name="vpc_apiv3_0016__li148301022882"></a><a name="li148301022882"></a>Default Value: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row382415221484"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p1383117221586">remote_address_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p58315221283">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p98311822786">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul183112212812"><li id="vpc_apiv3_0016__li983112222814"><p id="vpc_apiv3_0016__p58314227813"><a name="vpc_apiv3_0016__li983112222814"></a><a name="li983112222814"></a>Definition: ID of the remote IP address group of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li18311221983"><p id="vpc_apiv3_0016__p1183113227814"><a name="vpc_apiv3_0016__li18311221983"></a><a name="li18311221983"></a>Constraints: The parameter is mutually exclusive with parameters <strong id="vpc_apiv3_0016__b178311822286">remote_ip_prefix</strong> and <strong id="vpc_apiv3_0016__b1883114221811">remote_group_id</strong>.</p>
</li><li id="vpc_apiv3_0016__li383182216812"><p id="vpc_apiv3_0016__p283113221387"><a name="vpc_apiv3_0016__li383182216812"></a><a name="li383182216812"></a>Range: ID of an existing IP address group.</p>
</li><li id="vpc_apiv3_0016__li128311322781"><p id="vpc_apiv3_0016__p17831322486"><a name="vpc_apiv3_0016__li128311322781"></a><a name="li128311322781"></a>Default Value: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row5824222486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p78311522389">action</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p4831122215813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p283110229817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul88311221782"><li id="vpc_apiv3_0016__li1883110221283"><p id="vpc_apiv3_0016__p148311622984"><a name="vpc_apiv3_0016__li1883110221283"></a><a name="li1883110221283"></a>Definition: Action of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li198311122289"><p id="vpc_apiv3_0016__p14831132219819"><a name="vpc_apiv3_0016__li198311122289"></a><a name="li198311122289"></a>Constraints: None</p>
</li><li id="vpc_apiv3_0016__li883172216817"><p id="vpc_apiv3_0016__p58317224813"><a name="vpc_apiv3_0016__li883172216817"></a><a name="li883172216817"></a>Range:</p>
<ul id="vpc_apiv3_0016__ul118323224810"><li id="vpc_apiv3_0016__li118321222087"><p id="vpc_apiv3_0016__p1683272212818"><a name="vpc_apiv3_0016__li118321222087"></a><a name="li118321222087"></a><strong id="vpc_apiv3_0016__b108323221389">allow</strong></p>
</li><li id="vpc_apiv3_0016__li198326221886"><p id="vpc_apiv3_0016__p883217225815"><a name="vpc_apiv3_0016__li198326221886"></a><a name="li198326221886"></a><strong id="vpc_apiv3_0016__b1183210221381">deny</strong></p>
</li></ul>
</li><li id="vpc_apiv3_0016__li7832162213813"><p id="vpc_apiv3_0016__p16832112216820"><a name="vpc_apiv3_0016__li7832162213813"></a><a name="li7832162213813"></a>Default Value: <strong id="vpc_apiv3_0016__b1183212221786">allow</strong></p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row1982415221814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0016__p178321225819">priority</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0016__p178326224812">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0016__p483218221684">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0016__ul6832192213819"><li id="vpc_apiv3_0016__li783215221680"><p id="vpc_apiv3_0016__p28323221083"><a name="vpc_apiv3_0016__li783215221680"></a><a name="li783215221680"></a>Definition: Priority of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li118321522584"><p id="vpc_apiv3_0016__p4832822183"><a name="vpc_apiv3_0016__li118321522584"></a><a name="li118321522584"></a>Constraints: None</p>
</li><li id="vpc_apiv3_0016__li283242220814"><p id="vpc_apiv3_0016__p188328221186"><a name="vpc_apiv3_0016__li283242220814"></a><a name="li283242220814"></a>Range: The value is from 1 to 100. The value 1 indicates the highest priority.</p>
</li><li id="vpc_apiv3_0016__li88324221887"><p id="vpc_apiv3_0016__p178324228813"><a name="vpc_apiv3_0016__li88324221887"></a><a name="li88324221887"></a>Default Value: 1</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0016__section2833102211820"><h4 class="sectiontitle">Response Parameters</h4><p id="vpc_apiv3_0016__p1783382213811"><strong id="vpc_apiv3_0016__b17833142218814">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0016__response_CreateSecurityGroupRuleResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="vpc_apiv3_0016__row118331322483"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="vpc_apiv3_0016__p7834322784">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="vpc_apiv3_0016__p283418221985">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="vpc_apiv3_0016__p17834162212817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0016__row383352214810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_apiv3_0016__p18347229815">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_apiv3_0016__p9834522584">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><ul id="vpc_apiv3_0016__ul08341422688"><li id="vpc_apiv3_0016__li68341225815"><p id="vpc_apiv3_0016__p283416221088"><a name="vpc_apiv3_0016__li68341225815"></a><a name="li68341225815"></a>Definition: Request ID.</p>
</li><li id="vpc_apiv3_0016__li183413221785"><p id="vpc_apiv3_0016__p5834192212814"><a name="vpc_apiv3_0016__li183413221785"></a><a name="li183413221785"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row1783314220819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_apiv3_0016__p783411221385">security_group_rule</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_apiv3_0016__p1483419221280"><a href="#vpc_apiv3_0016__response_SecurityGroupRule">SecurityGroupRule</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><ul id="vpc_apiv3_0016__ul188341322987"><li id="vpc_apiv3_0016__li19834172216815"><p id="vpc_apiv3_0016__p118343229810"><a name="vpc_apiv3_0016__li19834172216815"></a><a name="li19834172216815"></a>Definition: Response body for creating a security group rule.</p>
</li><li id="vpc_apiv3_0016__li18341122981"><p id="vpc_apiv3_0016__p28349224817"><a name="vpc_apiv3_0016__li18341122981"></a><a name="li18341122981"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0016__response_SecurityGroupRule"></a><a name="response_SecurityGroupRule"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0016__response_SecurityGroupRule" frame="border" border="1" rules="all"><caption><b>Table 5 </b>SecurityGroupRule</caption><thead align="left"><tr id="vpc_apiv3_0016__row1835122217819"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="vpc_apiv3_0016__p1183612222812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="vpc_apiv3_0016__p283617228811">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="vpc_apiv3_0016__p9836822188">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0016__row1083520221082"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p178362221186">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p1483611225817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul783602215818"><li id="vpc_apiv3_0016__li183622217811"><p id="vpc_apiv3_0016__p48363221388"><a name="vpc_apiv3_0016__li183622217811"></a><a name="li183622217811"></a>Definition: ID of a security group rule. After a security group rule is created, a security group rule ID is generated, which uniquely identifies the security group rule.</p>
</li><li id="vpc_apiv3_0016__li783682217818"><p id="vpc_apiv3_0016__p198361922082"><a name="vpc_apiv3_0016__li783682217818"></a><a name="li783682217818"></a>Range: The value is in UUID format with hyphens (-).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row18351722284"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p1483616221887">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p158368222085">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul16836152212815"><li id="vpc_apiv3_0016__li083611224817"><p id="vpc_apiv3_0016__p178360224817"><a name="vpc_apiv3_0016__li083611224817"></a><a name="li083611224817"></a>Definition: Description of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li98361522584"><p id="vpc_apiv3_0016__p1383617222083"><a name="vpc_apiv3_0016__li98361522584"></a><a name="li98361522584"></a>Range: The value can contain no more than 255 characters and cannot contain angle brackets (&lt; or &gt;).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row38351822187"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p183711221787">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p48373227810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul128371122481"><li id="vpc_apiv3_0016__li28371522384"><p id="vpc_apiv3_0016__p128371722589"><a name="vpc_apiv3_0016__li28371522384"></a><a name="li28371522384"></a>Definition: ID of the security group that a security group rule belongs to.</p>
</li><li id="vpc_apiv3_0016__li783719224813"><p id="vpc_apiv3_0016__p1983714226812"><a name="vpc_apiv3_0016__li783719224813"></a><a name="li783719224813"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row14835822981"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p1883712217812">direction</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p8837722381">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul128370224817"><li id="vpc_apiv3_0016__li14837152210820"><p id="vpc_apiv3_0016__p9837122882"><a name="vpc_apiv3_0016__li14837152210820"></a><a name="li14837152210820"></a>Definition: Inbound or outbound direction of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li128375221586"><p id="vpc_apiv3_0016__p58375226819"><a name="vpc_apiv3_0016__li128375221586"></a><a name="li128375221586"></a>Range:</p>
<ul id="vpc_apiv3_0016__ul14837152210818"><li id="vpc_apiv3_0016__li17837202213818"><p id="vpc_apiv3_0016__p168370226810"><a name="vpc_apiv3_0016__li17837202213818"></a><a name="li17837202213818"></a><strong id="vpc_apiv3_0016__b18374221584">ingress</strong>: inbound direction</p>
</li><li id="vpc_apiv3_0016__li2837122217811"><p id="vpc_apiv3_0016__p683782219814"><a name="vpc_apiv3_0016__li2837122217811"></a><a name="li2837122217811"></a><strong id="vpc_apiv3_0016__b483717222084">egress</strong>: outbound direction</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row383512221381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p18837222784">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p6837112218816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul188371622980"><li id="vpc_apiv3_0016__li17837122212810"><p id="vpc_apiv3_0016__p1883810221086"><a name="vpc_apiv3_0016__li17837122212810"></a><a name="li17837122212810"></a>Definition: Communication protocol of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li783812221186"><p id="vpc_apiv3_0016__p12838822781"><a name="vpc_apiv3_0016__li783812221186"></a><a name="li783812221186"></a>Range:</p>
<ul id="vpc_apiv3_0016__ul6838122218819"><li id="vpc_apiv3_0016__li1483810222089"><p id="vpc_apiv3_0016__p148380224811"><a name="vpc_apiv3_0016__li1483810222089"></a><a name="li1483810222089"></a><strong id="vpc_apiv3_0016__b148388222083">icmp</strong></p>
</li><li id="vpc_apiv3_0016__li38382221983"><p id="vpc_apiv3_0016__p16838722782"><a name="vpc_apiv3_0016__li38382221983"></a><a name="li38382221983"></a><strong id="vpc_apiv3_0016__b98382220812">tcp</strong></p>
</li><li id="vpc_apiv3_0016__li1683817228820"><p id="vpc_apiv3_0016__p1983842219812"><a name="vpc_apiv3_0016__li1683817228820"></a><a name="li1683817228820"></a><strong id="vpc_apiv3_0016__b178383221084">udp</strong></p>
</li><li id="vpc_apiv3_0016__li148386223819"><p id="vpc_apiv3_0016__p98381922287"><a name="vpc_apiv3_0016__li148386223819"></a><a name="li148386223819"></a><strong id="vpc_apiv3_0016__b1383817222811">icmpv6</strong></p>
</li><li id="vpc_apiv3_0016__li2838622889"><p id="vpc_apiv3_0016__p178384223817"><a name="vpc_apiv3_0016__li2838622889"></a><a name="li2838622889"></a>IP protocol number</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row683532217815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p188385221785">ethertype</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p78381522189">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul141519231380"><li id="vpc_apiv3_0016__li11158231985"><p id="vpc_apiv3_0016__p20152231485"><a name="vpc_apiv3_0016__li11158231985"></a><a name="li11158231985"></a>Definition: IP address version of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li61512312813"><p id="vpc_apiv3_0016__p2016623383"><a name="vpc_apiv3_0016__li61512312813"></a><a name="li61512312813"></a>Range:</p>
<ul id="vpc_apiv3_0016__ul916723381"><li id="vpc_apiv3_0016__li161620231186"><p id="vpc_apiv3_0016__p6169236814"><a name="vpc_apiv3_0016__li161620231186"></a><a name="li161620231186"></a>IPv4</p>
</li><li id="vpc_apiv3_0016__li1916152318810"><p id="vpc_apiv3_0016__p3161238812"><a name="vpc_apiv3_0016__li1916152318810"></a><a name="li1916152318810"></a>IPv6</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row8835622783"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p3168231589">multiport</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p116162312819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul01611231082"><li id="vpc_apiv3_0016__li71612231587"><p id="vpc_apiv3_0016__p1916182315819"><a name="vpc_apiv3_0016__li71612231587"></a><a name="li71612231587"></a>Definition: Port range of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li151672316818"><p id="vpc_apiv3_0016__p12164231382"><a name="vpc_apiv3_0016__li151672316818"></a><a name="li151672316818"></a>Range: The value can be a single port (80), a port range (1-30), or inconsecutive ports separated by commas (22,3389,80).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row783522220812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p13161823781">action</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p121616239819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul131692315815"><li id="vpc_apiv3_0016__li2161723786"><p id="vpc_apiv3_0016__p141652313819"><a name="vpc_apiv3_0016__li2161723786"></a><a name="li2161723786"></a>Definition: Action of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li1416923482"><p id="vpc_apiv3_0016__p8161923983"><a name="vpc_apiv3_0016__li1416923482"></a><a name="li1416923482"></a>Range:</p>
<ul id="vpc_apiv3_0016__ul14164232819"><li id="vpc_apiv3_0016__li416823181"><p id="vpc_apiv3_0016__p2016102312811"><a name="vpc_apiv3_0016__li416823181"></a><a name="li416823181"></a><strong id="vpc_apiv3_0016__b161614235814">allow</strong></p>
</li><li id="vpc_apiv3_0016__li201615231780"><p id="vpc_apiv3_0016__p15161123387"><a name="vpc_apiv3_0016__li201615231780"></a><a name="li201615231780"></a><strong id="vpc_apiv3_0016__b9163231083">deny</strong></p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row18356221788"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p171662313811">priority</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p171612231386">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul11162231884"><li id="vpc_apiv3_0016__li15161231086"><p id="vpc_apiv3_0016__p6164231988"><a name="vpc_apiv3_0016__li15161231086"></a><a name="li15161231086"></a>Definition: Priority of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li616523689"><p id="vpc_apiv3_0016__p1516223388"><a name="vpc_apiv3_0016__li616523689"></a><a name="li616523689"></a>Range: The value is from 1 to 100. The value 1 indicates the highest priority.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row68359221782"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p121619231483">remote_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p171620231187">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul171632315817"><li id="vpc_apiv3_0016__li16161523381"><p id="vpc_apiv3_0016__p1216523280"><a name="vpc_apiv3_0016__li16161523381"></a><a name="li16161523381"></a>Definition: ID of the remote security group of a security group rule. If the action of the rule is <strong id="vpc_apiv3_0016__b016132310812">allow</strong>, the traffic from the remote security group is allowed. If the action of the rule is <strong id="vpc_apiv3_0016__b151611231486">deny</strong>, the traffic from the remote security group is denied.</p>
</li><li id="vpc_apiv3_0016__li171617237816"><p id="vpc_apiv3_0016__p101619231886"><a name="vpc_apiv3_0016__li171617237816"></a><a name="li171617237816"></a>Range: ID of an existing security group.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row7835152212814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p91613231389">remote_ip_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p71613231983">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul121662319813"><li id="vpc_apiv3_0016__li01612312819"><p id="vpc_apiv3_0016__p12166231389"><a name="vpc_apiv3_0016__li01612312819"></a><a name="li01612312819"></a>Definition: Remote IP address of a security group rule.</p>
<ul id="vpc_apiv3_0016__ul31662311815"><li id="vpc_apiv3_0016__li51611231286"><p id="vpc_apiv3_0016__p1016723888"><a name="vpc_apiv3_0016__li51611231286"></a><a name="li51611231286"></a>If <strong id="vpc_apiv3_0016__b111712236818">direction</strong> is set to <strong id="vpc_apiv3_0016__b101714231580">egress</strong>, the IP address is the outbound destination and will be accessed by instances in the security group.</p>
</li><li id="vpc_apiv3_0016__li14178231689"><p id="vpc_apiv3_0016__p21719231486"><a name="vpc_apiv3_0016__li14178231689"></a><a name="li14178231689"></a>If <strong id="vpc_apiv3_0016__b4171123989">direction</strong> is set to <strong id="vpc_apiv3_0016__b51717236816">ingress</strong>, the IP address is the inbound source and will access the instances in the security group.</p>
</li></ul>
</li><li id="vpc_apiv3_0016__li71772311818"><p id="vpc_apiv3_0016__p6170231685"><a name="vpc_apiv3_0016__li71772311818"></a><a name="li71772311818"></a>Range: CIDR notation format. If an IP address is transferred in the request, the IP address is automatically formatted with /32 as the subnet mask, for example, 192.168.21.45/32.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row1835182217815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p51722311817">remote_address_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p51711231819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul51792319814"><li id="vpc_apiv3_0016__li191714231888"><p id="vpc_apiv3_0016__p3171523582"><a name="vpc_apiv3_0016__li191714231888"></a><a name="li191714231888"></a>Definition: ID of the remote IP address group of a security group rule.</p>
</li><li id="vpc_apiv3_0016__li141762310816"><p id="vpc_apiv3_0016__p21718230814"><a name="vpc_apiv3_0016__li141762310816"></a><a name="li141762310816"></a>Range: ID of an existing IP address group.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row3835122216813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p31715231186">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p181720230813">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul13171523481"><li id="vpc_apiv3_0016__li21717231788"><p id="vpc_apiv3_0016__p101718231287"><a name="vpc_apiv3_0016__li21717231788"></a><a name="li21717231788"></a>Definition: Time when a security group rule was created.</p>
</li><li id="vpc_apiv3_0016__li91782315813"><p id="vpc_apiv3_0016__p101722318816"><a name="vpc_apiv3_0016__li91782315813"></a><a name="li91782315813"></a>Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row38355221586"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p31712235818">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p141742318819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul181714231814"><li id="vpc_apiv3_0016__li171792315815"><p id="vpc_apiv3_0016__p2175231783"><a name="vpc_apiv3_0016__li171792315815"></a><a name="li171792315815"></a>Definition: Time when a security group rule was updated.</p>
</li><li id="vpc_apiv3_0016__li6178231387"><p id="vpc_apiv3_0016__p13179231384"><a name="vpc_apiv3_0016__li6178231387"></a><a name="li6178231387"></a>Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row138353227813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0016__p18176231811">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0016__p18170231483">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0016__ul14171023682"><li id="vpc_apiv3_0016__li9172231989"><p id="vpc_apiv3_0016__p417112316811"><a name="vpc_apiv3_0016__li9172231989"></a><a name="li9172231989"></a>Definition: ID of the project that a security group rule belongs to.</p>
</li><li id="vpc_apiv3_0016__li8177231782"><p id="vpc_apiv3_0016__p1172231384"><a name="vpc_apiv3_0016__li8177231782"></a><a name="li8177231782"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<p id="vpc_apiv3_0016__p141719230816"><strong id="vpc_apiv3_0016__b18171123388">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0016__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="vpc_apiv3_0016__row8842102219811"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="vpc_apiv3_0016__p917112316816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="vpc_apiv3_0016__p13171523685">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="vpc_apiv3_0016__p917123889">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0016__row18420221389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="vpc_apiv3_0016__p181712313819">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="vpc_apiv3_0016__p7175232812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><ul id="vpc_apiv3_0016__ul201719231781"><li id="vpc_apiv3_0016__li7177231686"><p id="vpc_apiv3_0016__p14170239817"><a name="vpc_apiv3_0016__li7177231686"></a><a name="li7177231686"></a>Definition: Request ID.</p>
</li><li id="vpc_apiv3_0016__li1717112316817"><p id="vpc_apiv3_0016__p11710231580"><a name="vpc_apiv3_0016__li1717112316817"></a><a name="li1717112316817"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row168421222189"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="vpc_apiv3_0016__p4179232811">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="vpc_apiv3_0016__p1818102312818">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><ul id="vpc_apiv3_0016__ul11184231287"><li id="vpc_apiv3_0016__li10181123383"><p id="vpc_apiv3_0016__p15181231582"><a name="vpc_apiv3_0016__li10181123383"></a><a name="li10181123383"></a>Definition: Error message.</p>
</li><li id="vpc_apiv3_0016__li318132315813"><p id="vpc_apiv3_0016__p7188231587"><a name="vpc_apiv3_0016__li318132315813"></a><a name="li318132315813"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0016__row1842822283"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="vpc_apiv3_0016__p1183231885">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="vpc_apiv3_0016__p121812231584">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><ul id="vpc_apiv3_0016__ul1718102319813"><li id="vpc_apiv3_0016__li11819231984"><p id="vpc_apiv3_0016__p518182320815"><a name="vpc_apiv3_0016__li11819231984"></a><a name="li11819231984"></a>Definition: Error code.</p>
</li><li id="vpc_apiv3_0016__li31872317815"><p id="vpc_apiv3_0016__p151811231982"><a name="vpc_apiv3_0016__li31872317815"></a><a name="li31872317815"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0016__section151842312812"><h4 class="sectiontitle">Example Requests</h4><p id="vpc_apiv3_0016__p101882314816">Create an inbound rule in the security group whose ID is 0552091e-b83a-49dd-88a7-4a5c86fd9ec3.</p>
<pre class="screen" id="vpc_apiv3_0016__screen1118623783">POST https://{Endpoint}/v3/{project_id}/vpc/security-group-rules
{
"security_group_rule" : {
"security_group_id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
"direction" : "ingress",
"protocol" : "tcp",
"description" : "security group rule description",
"action" : "allow",
"priority" : 1,
"multiport" : "33",
"remote_ip_prefix" : "10.10.0.0/16"
}
}</pre>
</div>
<div class="section" id="vpc_apiv3_0016__section1118423589"><h4 class="sectiontitle">Example Responses</h4><p id="vpc_apiv3_0016__p1718172320814"><strong id="vpc_apiv3_0016__b21852319819">Status code: 201</strong></p>
<p id="vpc_apiv3_0016__p10181223884">Normal response to the POST operation. For more status codes, see <a href="vpc_api_0002.html">Status Codes</a>.</p>
<pre class="screen" id="vpc_apiv3_0016__screen16182237817">{
"request_id" : "1666b2708aaf849337572d6846dce781",
"security_group_rule" : {
"id" : "f626eb24-d8bd-4d26-ae0b-c16bb65730cb",
"project_id" : "060576782980d5762f9ec014dd2f1148",
"security_group_id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
"direction" : "ingress",
"protocol" : "tcp",
"description" : "security group rule description",
"created_at" : "2020-08-13T07:12:36.000+00:00",
"updated_at" : "2020-08-13T07:12:36.000+00:00",
"ethertype" : "IPv4",
"remote_ip_prefix" : "10.10.0.0/16",
"multiport" : 33,
"action" : "allow",
"priority" : 1,
"remote_group_id" : null,
"remote_address_group_id" : null
}
}</pre>
<p id="vpc_apiv3_0016__p15188231885"><strong id="vpc_apiv3_0016__b1118192317810">Status code: 202</strong></p>
<p id="vpc_apiv3_0016__p6183234815">Normal response for the specified pre-check request of API V3. For more status codes, see <a href="vpc_api_0002.html">Status Code</a>.</p>
<pre class="screen" id="vpc_apiv3_0016__screen31872311811">{
"error_msg" : "Request validation has been passed with dry run...",
"error_code" : "SYS.0202",
"request_id" : "cfd81aea3f59eac7128dba4b36d516c8"
}</pre>
</div>
<div class="section" id="vpc_apiv3_0016__section20187231587"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0016__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="vpc_apiv3_0016__row684414221813"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="vpc_apiv3_0016__p2181523582">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="vpc_apiv3_0016__p9188233814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0016__row284413223816"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="vpc_apiv3_0016__p7186231816">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="vpc_apiv3_0016__p16183233811">Normal response to the POST operation. For more status codes, see <a href="vpc_api_0002.html">Status Codes</a>.</p>
</td>
</tr>
<tr id="vpc_apiv3_0016__row98446221812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="vpc_apiv3_0016__p12185231288">202</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="vpc_apiv3_0016__p19185231285">Normal response for the specified pre-check request of API V3. For more status codes, see <a href="vpc_api_0002.html">Status Code</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0016__section31802315816"><h4 class="sectiontitle">Error Codes</h4><p id="vpc_apiv3_0016__p7180233816">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_apiv3_0015.html">Security Group Rule</a></div>
</div>
</div>
View Git Blame Copy Permalink