forked from docs/doc-exports
Artem Goncharov
3196b64bfc
move doc sources to other location Reviewed-by: OpenTelekomCloud Bot <None>
183 lines
16 KiB
HTML
183 lines
16 KiB
HTML
<a name="EN-US_TOPIC_0090187680"></a><a name="EN-US_TOPIC_0090187680"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Security Group (Discarded)</h1>
|
|
<div id="body1514024530118"><div class="section" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_section27950026"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p8413469">This API is used to create a security group.</p>
|
|
<p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p1146061620560">This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) > Creating a Security Group" in <em id="EN-US_TOPIC_0090187680__i1823683115013">Virtual Private Network API Reference</em>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_section50223649"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0090187680__p198751169416">POST /v2/{project_id}/os-security-groups</p>
|
|
<p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p66228246145352">POST /v2.1/{project_id}/os-security-groups</p>
|
|
<div class="p" id="EN-US_TOPIC_0090187680__p1476605819202"><a href="#EN-US_TOPIC_0090187680__en-us_topic_0057972662_table55945983">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187680__en-us_topic_0057972662_table55945983"></a><a name="en-us_topic_0057972662_table55945983"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_table55945983" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_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_0090187680__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_0090187680__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_0090187680__p8497414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row49888896"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_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_0090187680__en-us_topic_0057972662_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_0090187680__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_section41583755"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0090187680__p1680141562111"><a href="#EN-US_TOPIC_0090187680__en-us_topic_0057972662_table63943666">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187680__en-us_topic_0057972662_table63943666"></a><a name="en-us_topic_0057972662_table63943666"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_table63943666" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row46071449"><th align="left" class="cellrowborder" valign="top" width="21.587841215878413%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0090187680__en-us_topic_0058745339_p39560242204918">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.588541145885412%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0090187680__p776915317295">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.347865213478652%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0090187680__en-us_topic_0058745339_p50263001204918">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.47575242475752%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0090187680__en-us_topic_0058745339_p2596798204918">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row10655236"><td class="cellrowborder" valign="top" width="21.587841215878413%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p57767782">security_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.588541145885412%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0090187680__p776919314292">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.347865213478652%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p48678752">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.47575242475752%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p10212927">Specifies the security group, which is configured in the message body. For details, see <a href="#EN-US_TOPIC_0090187680__en-us_topic_0057972662_table21940722">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187680__en-us_topic_0057972662_table21940722"></a><a name="en-us_topic_0057972662_table21940722"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_table21940722" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Objects of request parameter <strong id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_b842352706144721">security_group</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row43216271"><th align="left" class="cellrowborder" valign="top" width="22.157784221577842%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0090187680__p1485183101118">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.018598140185981%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0090187680__p987214010294">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.347865213478652%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0090187680__p18485336113">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.47575242475752%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0090187680__p1648517315115">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row57557412"><td class="cellrowborder" valign="top" width="22.157784221577842%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p31638772">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.018598140185981%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0090187680__p13872104052910">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.347865213478652%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p415393471693">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.47575242475752%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p15080136">Specifies the security group name. It must contain 0 to 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row1503503"><td class="cellrowborder" valign="top" width="22.157784221577842%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p54674917">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.018598140185981%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0090187680__p087214408298">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.347865213478652%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p449516831693">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.47575242475752%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p32242465">Specifies information about a security group. It must contain 0 to 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_section38709481"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0090187680__p34321336182217"><a href="#EN-US_TOPIC_0090187680__en-us_topic_0057972662_table61502840">Table 4</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187680__en-us_topic_0057972662_table61502840"></a><a name="en-us_topic_0057972662_table61502840"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_table61502840" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row45420240"><th align="left" class="cellrowborder" valign="top" width="29.95299529952995%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0090187680__p17521191015112">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.65236523652365%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0090187680__p35211110111112">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.39463946394639%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0090187680__p105377109114">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row49282936"><td class="cellrowborder" valign="top" width="29.95299529952995%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p32494840">security_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.65236523652365%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p14836356">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.39463946394639%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p33484259">Specifies the security group. For details, see <a href="#EN-US_TOPIC_0090187680__en-us_topic_0057972662_table27870469">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0090187680__en-us_topic_0057972662_table27870469"></a><a name="en-us_topic_0057972662_table27870469"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_table27870469" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Objects of response parameter <strong id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_b247743252144737">security_group</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row21933905"><th align="left" class="cellrowborder" valign="top" width="30.023002300230022%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0090187680__p11189161310116">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.023002300230022%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0090187680__p1118951313111">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.953995399539956%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0090187680__p181891413161115">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row36810105"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p28828491">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p6329693416937">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p24345054">Provides supplementary information about the security group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row17778899"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p30804749">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p5717066816937">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p35225966">Specifies the security group ID in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row48598242"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p44143566">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p4300522616937">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p52667802">Specifies the security group name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row4248175"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p8557861">rules</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p4177153616937">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p30752875">Specifies the rules of the security group. The list is empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_row8340425"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p4485813">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p5835901916937">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_p36771698">Specifies the tenant or project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_section12841014"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0090187680__screen39239322147">POST https://{endpoint}/v2/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups
|
|
POST https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups</pre>
|
|
<pre class="screen" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_screen4486138911286">{
|
|
"security_group": {
|
|
"name": "test",
|
|
"description": "description"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0090187680__section817065572614"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0090187680__screen0178055122619">{
|
|
"security_group": {
|
|
"rules": [],
|
|
"tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
|
|
"description": "desc-sg",
|
|
"id": "81f1d23b-b1e2-42cd-bdee-359b4a065a42",
|
|
"name": "test-sg"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_en-us_topic_0020212692_section22960139"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0090187680__en-us_topic_0057972662_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>
|
|
|