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

357 lines
32 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0065817700"></a><a name="EN-US_TOPIC_0065817700"></a>
<h1 class="topictitle1">Updating a Security Group (Discarded)</h1>
<div id="body1499652824861"><div class="section" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_section65665194"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p31407785">This API is used to update a security group.</p>
<p id="EN-US_TOPIC_0065817700__en-us_topic_0057972662_p1146061620560">This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) &gt; Updating a Security Group" in <em id="EN-US_TOPIC_0065817700__i13849626111911">Virtual Private Network API Reference</em>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_section54115834"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065817700__p126331115114210">PUT /v2/{project_id}/os-security-groups/{security_group_id}</p>
<p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p66228246145352">PUT /v2.1/{project_id}/os-security-groups/{security_group_id}</p>
<div class="p" id="EN-US_TOPIC_0065817700__p313720272268"><a href="#EN-US_TOPIC_0065817700__en-us_topic_0057972664_table55945983">Table 1</a> describes the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table55945983"></a><a name="en-us_topic_0057972664_table55945983"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table55945983" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row11302482"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0065817700__p5187119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0065817700__p17503500">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0065817700__p8497414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row49888896"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p14468758">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p31118786">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817700__p37593705">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row3928161611210"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p4928516101217">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p18928816181213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p292821613128">Specifies the security group ID, which is specified in the URI.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_section21306406"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065817700__p5418102214342"><a href="#EN-US_TOPIC_0065817700__en-us_topic_0057972664_table52078514">Table 2</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table52078514"></a><a name="en-us_topic_0057972664_table52078514"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table52078514" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row2492560"><th align="left" class="cellrowborder" valign="top" width="21.71%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0065817700__en-us_topic_0058745339_p39560242204918">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.14%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0065817700__p125971723123015">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.750000000000007%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0065817700__en-us_topic_0058745339_p50263001204918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.400000000000006%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0065817700__en-us_topic_0058745339_p2596798204918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row30749271"><td class="cellrowborder" valign="top" width="21.71%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p7663035">security_group</p>
</td>
<td class="cellrowborder" valign="top" width="16.14%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p5597172311304">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25.750000000000007%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p16726062">Object</p>
</td>
<td class="cellrowborder" valign="top" width="36.400000000000006%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p16706408">Specifies the security group in the message body. For details, see <a href="#EN-US_TOPIC_0065817700__en-us_topic_0057972664_table11041789">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table11041789"></a><a name="en-us_topic_0057972664_table11041789"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table11041789" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Objects of request parameter <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706144721">security_group</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row9230088"><th align="left" class="cellrowborder" valign="top" width="22.167783221677833%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0065817700__p14601427201219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.978402159784022%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0065817700__p67171626153010">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.587441255874417%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0065817700__p146052771212">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.266373362663735%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0065817700__p20601027181211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row7414170"><td class="cellrowborder" valign="top" width="22.167783221677833%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p63676932">name</p>
</td>
<td class="cellrowborder" valign="top" width="15.978402159784022%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p57171626103012">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25.587441255874417%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p57557895">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p15772917">Specifies the security group name.</p>
<p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p9152184911574">The value cannot exceed 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row7738529"><td class="cellrowborder" valign="top" width="22.167783221677833%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p22841149">description</p>
</td>
<td class="cellrowborder" valign="top" width="15.978402159784022%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p4717926203010">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25.587441255874417%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p38193748">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p4687385">Specifies information about a security group.</p>
<p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p1733534185813">The value cannot exceed 255 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_section57539933"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065817700__p923916913515"><a href="#EN-US_TOPIC_0065817700__en-us_topic_0057972664_table44133910">Table 4</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table44133910"></a><a name="en-us_topic_0057972664_table44133910"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table44133910" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row60896162"><th align="left" class="cellrowborder" valign="top" width="22.277772222777724%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0065817700__p875863061217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.44835516448355%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0065817700__p45394474304">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.007499250074993%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0065817700__p1875853061210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.266373362663735%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0065817700__p197581530181210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row17602849"><td class="cellrowborder" valign="top" width="22.277772222777724%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p16544703">security_group</p>
</td>
<td class="cellrowborder" valign="top" width="16.44835516448355%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p2539147153014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25.007499250074993%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p65052577">Object</p>
</td>
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p64696659">Specifies the security group. For details, see <a href="#EN-US_TOPIC_0065817700__en-us_topic_0057972664_table5938035">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table5938035"></a><a name="en-us_topic_0057972664_table5938035"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table5938035" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Objects of response parameter <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b247743252144737">security_group</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row27762102"><th align="left" class="cellrowborder" valign="top" width="19.31%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0065817700__p13502533121212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.939999999999998%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0065817700__p730821283112">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.35%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0065817700__p155181933111211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.4%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0065817700__p125181533171211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row21024178"><td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p25236858">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.939999999999998%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p1308191263113">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.35%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p8741693161834">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p4222112625811">Specifies information about a security group.</p>
<p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p60714046">The value cannot exceed 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row9555503"><td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p35798250">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.939999999999998%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p9308101253120">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.35%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p58105597161834">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p33323423">Specifies the security group ID in UUID format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row31475357"><td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p66476022">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.939999999999998%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p14308191211315">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.35%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p66138500161834">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p31741019">Specifies the security group name.</p>
<p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p49657545587">The value cannot exceed 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row17233719"><td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p53754023">rules</p>
</td>
<td class="cellrowborder" valign="top" width="16.939999999999998%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p15308191293111">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.35%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p61314810161834">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p56666602">Specifies the security group rule list. For details, see <a href="#EN-US_TOPIC_0065817700__en-us_topic_0057972664_table64215808">Table 6</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row40237373"><td class="cellrowborder" valign="top" width="19.31%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p38001806">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.939999999999998%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p830819125312">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.35%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p8281316161834">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p43875021">Specifies the tenant or project ID.</p>
<p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p209451415910">The value cannot exceed 255 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table64215808"></a><a name="en-us_topic_0057972664_table64215808"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table64215808" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b897031316622">security_group_rule</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row50789581"><th align="left" class="cellrowborder" valign="top" width="19.598040195980403%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0065817700__p14934193631220">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.728327167283272%" id="mcps1.3.4.5.2.5.1.2"><p id="EN-US_TOPIC_0065817700__p839243119312">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.407259274072594%" id="mcps1.3.4.5.2.5.1.3"><p id="EN-US_TOPIC_0065817700__p1593416362121">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.266373362663735%" id="mcps1.3.4.5.2.5.1.4"><p id="EN-US_TOPIC_0065817700__p10934636101219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row16670523"><td class="cellrowborder" valign="top" width="19.598040195980403%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p2523549416194">parent_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.728327167283272%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p1392183173116">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.407259274072594%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p2351847316194">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p3955312816194">Specifies the associated security group ID in UUID format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row55443761"><td class="cellrowborder" valign="top" width="19.598040195980403%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p5606438216194">ip_protocol</p>
</td>
<td class="cellrowborder" valign="top" width="16.728327167283272%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p8393133163114">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.407259274072594%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p6351133316194">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p4556843916194">Specifies the protocol type or the IP protocol number. The value can be <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b84235270618469">icmp</strong>, <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b84235270619548">tcp</strong>, <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706184613">udp</strong>, or the IP protocol number.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row63384014"><td class="cellrowborder" valign="top" width="19.598040195980403%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p3850893516194">from_port</p>
</td>
<td class="cellrowborder" valign="top" width="16.728327167283272%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p153935313314">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.407259274072594%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p138869916194">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p2078843616194">Specifies the start port. The value ranges from 1 to 65,535 and cannot be greater than <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706192235">to_port</strong>. When <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b84235270619236">ip_protocol</strong> is <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706192316">icmp</strong>, this parameter specifies a port type with a length from 0 to 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row56087165"><td class="cellrowborder" valign="top" width="19.598040195980403%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p2893204816194">to_port</p>
</td>
<td class="cellrowborder" valign="top" width="16.728327167283272%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p43932313319">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.407259274072594%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p5065329216194">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p2803062516194">Specifies the end port. The value ranges from 1 to 65,535 and cannot be less than <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706162914">from_port</strong>. When <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706162939">ip_protocol</strong> is <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706162947">icmp</strong>, it specifies the code. The value ranges from 0 to 255. If both <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706163018">from_port</strong> and <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706163116">to_port</strong> are <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706163025">-1</strong>, any ICMP packet can be transmitted.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row59740974"><td class="cellrowborder" valign="top" width="19.598040195980403%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p5271149216194">ip_range</p>
</td>
<td class="cellrowborder" valign="top" width="16.728327167283272%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p639323103118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.407259274072594%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p6042635416194">Object</p>
</td>
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p5897723816194">Specifies the peer IP segment in CIDR format. For details, see <a href="#EN-US_TOPIC_0065817700__en-us_topic_0057972664_table4101480163218">Table 7</a>. The value of <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b84235270618494">ip_range</strong> or <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b84235270618498">group</strong> must be empty.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row18301082"><td class="cellrowborder" valign="top" width="19.598040195980403%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p3354966816194">group</p>
</td>
<td class="cellrowborder" valign="top" width="16.728327167283272%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p18393153115317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.407259274072594%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p6004111716194">Object</p>
</td>
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p5918086916194">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_0065817700__en-us_topic_0057972664_table9527961163416">Table 8</a>. The value of <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b1152282663192924">ip_range</strong> or <strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b506241931192924">group</strong> must be empty.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row3099778"><td class="cellrowborder" valign="top" width="19.598040195980403%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p2717504716194">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.728327167283272%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p1239333183111">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.407259274072594%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p3013279116194">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p5953487016194">Specifies the security group rule ID in UUID format.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table4101480163218"></a><a name="en-us_topic_0057972664_table4101480163218"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table4101480163218" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="EN-US_TOPIC_0065817700__b22002965">ip_range</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row55642344163218"><th align="left" class="cellrowborder" valign="top" width="19.470000000000002%" id="mcps1.3.4.6.2.5.1.1"><p id="EN-US_TOPIC_0065817700__p17249416128">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.78%" id="mcps1.3.4.6.2.5.1.2"><p id="EN-US_TOPIC_0065817700__p12695115783116">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.139999999999997%" id="mcps1.3.4.6.2.5.1.3"><p id="EN-US_TOPIC_0065817700__p272414151210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.61%" id="mcps1.3.4.6.2.5.1.4"><p id="EN-US_TOPIC_0065817700__p47247419120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row5649056163218"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p54920430163218">cidr</p>
</td>
<td class="cellrowborder" valign="top" width="16.78%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p196951557143110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="27.139999999999997%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p19369856163218">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.61%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p48550802163218">Specifies the peer IP segment in CIDR format.</p>
<p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p9404201915595">The value cannot exceed 255 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table9527961163416"></a><a name="en-us_topic_0057972664_table9527961163416"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_table9527961163416" frame="border" border="1" rules="all"><caption><b>Table 8 </b><strong id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_b842352706185646">group</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row57542164163416"><th align="left" class="cellrowborder" valign="top" width="18.76187618761876%" id="mcps1.3.4.7.2.5.1.1"><p id="EN-US_TOPIC_0065817700__p44391448122">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.121712171217123%" id="mcps1.3.4.7.2.5.1.2"><p id="EN-US_TOPIC_0065817700__p1914510120324">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.862686268626863%" id="mcps1.3.4.7.2.5.1.3"><p id="EN-US_TOPIC_0065817700__p3439134412128">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.253725372537254%" id="mcps1.3.4.7.2.5.1.4"><p id="EN-US_TOPIC_0065817700__p24391044131213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row46600064163416"><td class="cellrowborder" valign="top" width="18.76187618761876%" headers="mcps1.3.4.7.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p16508853163416">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.4.7.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p214619118324">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="26.862686268626863%" headers="mcps1.3.4.7.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p62148702163416">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.253725372537254%" headers="mcps1.3.4.7.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p4179246163416">Specifies the ID of the tenant of the peer security group.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_row37613216163416"><td class="cellrowborder" valign="top" width="18.76187618761876%" headers="mcps1.3.4.7.2.5.1.1 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p26771660163416">name</p>
</td>
<td class="cellrowborder" valign="top" width="17.121712171217123%" headers="mcps1.3.4.7.2.5.1.2 "><p id="EN-US_TOPIC_0065817700__p61462173213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="26.862686268626863%" headers="mcps1.3.4.7.2.5.1.3 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p21020848163416">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.253725372537254%" headers="mcps1.3.4.7.2.5.1.4 "><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_p9073859163416">Specifies the name of the peer security group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_section48097351"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0065817700__screen124221593147">PUT https://{endpoint}/v2/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups/3d02312d-0764-49c9-8244-2368ddce0045
PUT https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups/3d02312d-0764-49c9-8244-2368ddce0045</pre>
<pre class="screen" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_screen56780751112942">{
"security_group": {
"name": "test",
"description": "description"
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065817700__section435415620273"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065817700__screen1536845652718">{
"security_group": {
"rules": [
{
"from_port": null,
"group": {
"tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
"name": "test"
},
"ip_protocol": null,
"to_port": null,
"parent_group_id": "3d02312d-0764-49c9-8244-2368ddce0045",
"ip_range": {},
"id": "00dec0b6-8e96-4906-aadf-46cfe54cf5ef"
}
],
"tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
"id": "3d02312d-0764-49c9-8244-2368ddce0045",
"name": "test",
"description": "description"
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_en-us_topic_0020212692_section22960139"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065817700__en-us_topic_0057972664_en-us_topic_0020212692_p23670760">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0267427144.html">Security Group Management (OpenStack Nova APIs)</a></div>
</div>
</div>
View Git Blame Copy Permalink