youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpc/api-ref/vpc_sg02_0001.html
gtema 4cfecba474 VPC api from PR#278 
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-10-17 12:39:05 +00:00

399 lines
33 KiB
HTML
Raw Blame History

<a name="vpc_sg02_0001"></a><a name="vpc_sg02_0001"></a>
<h1 class="topictitle1">Querying Security Groups</h1>
<div id="body1495612290168"><div class="section" id="vpc_sg02_0001__section1170323616037"><h4 class="sectiontitle">Function</h4><p id="vpc_sg02_0001__p11291224136">This API is used to query all security groups accessible to the tenant submitting the request. </p>
</div>
<div class="section" id="vpc_sg02_0001__section2797834416037"><h4 class="sectiontitle">URI</h4><p id="vpc_sg02_0001__p1739172110217">GET /v2.0/security-groups</p>
<p id="vpc_sg02_0001__p207281756175818">Example of querying security groups by page</p>
<pre class="screen" id="vpc_sg02_0001__screen6349039695144">GET https://{Endpoint}/v2.0/security-groups?limit=2&amp;marker=0431c9c5-1660-42e0-8a00-134bec7f03e2&amp;page_reverse=False</pre>
</div>
<p id="vpc_sg02_0001__p896351717225"><a href="#vpc_sg02_0001__table1687161718223">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="vpc_sg02_0001__table1687161718223"></a><a name="table1687161718223"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_sg02_0001__table1687161718223" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_sg02_0001__row396316178224"><th align="left" class="cellrowborder" valign="top" width="22.222222222222225%" id="mcps1.3.4.2.5.1.1"><p id="vpc_sg02_0001__p14963617122211"><strong id="vpc_sg02_0001__b795715382317">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.14141414141414%" id="mcps1.3.4.2.5.1.2"><p id="vpc_sg02_0001__p19964161752210"><strong id="vpc_sg02_0001__b146961839153118">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.54175417541754%" id="mcps1.3.4.2.5.1.3"><p id="vpc_sg02_0001__p1396481772212"><strong id="vpc_sg02_0001__b372134017317">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.09460946094609%" id="mcps1.3.4.2.5.1.4"><p id="vpc_sg02_0001__p796421711226"><strong id="vpc_sg02_0001__b105381041173112">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_sg02_0001__row17964117122212"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_sg02_0001__p1396481719225">id</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_sg02_0001__p17964717142210">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.54175417541754%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_sg02_0001__p8964417192215">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.09460946094609%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_sg02_0001__p169644177228">Specifies that the ID is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__row69646172222"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_sg02_0001__p89647174229">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_sg02_0001__p6964111702216">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.54175417541754%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_sg02_0001__p296421782217">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.09460946094609%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_sg02_0001__p11964717192216">Specifies that the name is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__row1996419172225"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_sg02_0001__p2096413173223">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_sg02_0001__p596421732212">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.54175417541754%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_sg02_0001__p10964131710228">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.09460946094609%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_sg02_0001__p2096421719225">Specifies that the description is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__row396451752217"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_sg02_0001__p179648172225">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_sg02_0001__p196411752220">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.54175417541754%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_sg02_0001__p11964181772212">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.09460946094609%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_sg02_0001__p5964217162211">Specifies that the project ID is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__row39646172224"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_sg02_0001__p109641217162215">marker</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_sg02_0001__p199641717112219">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.54175417541754%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_sg02_0001__p796412174223">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.09460946094609%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_sg02_0001__p28526205175853">Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.</p>
<p id="vpc_sg02_0001__p538818488578">This parameter can work together with the parameter <strong id="vpc_sg02_0001__vpc_api01_0003_b650614119446">limit</strong>.</p>
<ul id="vpc_sg02_0001__ul12704811125810"><li id="vpc_sg02_0001__vpc_api01_0003_li325418407124">If parameters <strong id="vpc_sg02_0001__vpc_api01_0003_b736582413514">marker</strong> and <strong id="vpc_sg02_0001__vpc_api01_0003_b17435293518">limit</strong> are not passed, all resource records will be returned.</li><li id="vpc_sg02_0001__vpc_api01_0003_li1923817171338">If the parameter <strong id="vpc_sg02_0001__vpc_api01_0003_b1505159195414">marker</strong> is not passed and the value of parameter <strong id="vpc_sg02_0001__vpc_api01_0003_b14146122925417">limit</strong> is set to <strong id="vpc_sg02_0001__vpc_api01_0003_b13594516546">10</strong>, the first 10 resource records will be returned.</li><li id="vpc_sg02_0001__vpc_api01_0003_li2076741203417">If the value of the parameter <strong id="vpc_sg02_0001__vpc_api01_0003_b13589356163415">marker</strong> is set to the resource ID of the 10th record and the value of parameter <strong id="vpc_sg02_0001__vpc_api01_0003_b1557415118357">limit</strong> is set to <strong id="vpc_sg02_0001__vpc_api01_0003_b10574171193511">10</strong>, the 11th to 20th resource records will be returned.</li><li id="vpc_sg02_0001__vpc_api01_0003_li108512113551">If the value of the parameter <strong id="vpc_sg02_0001__vpc_api01_0003_b9403193716543">marker</strong> is set to the resource ID of the 10th record and the parameter <strong id="vpc_sg02_0001__vpc_api01_0003_b10358823165519">limit</strong> is not passed, resource records starting from the 11th records (including 11th) will be returned.</li></ul>
</td>
</tr>
<tr id="vpc_sg02_0001__row10964201702215"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_sg02_0001__p10964111722211">limit</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_sg02_0001__p896421742213">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.54175417541754%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_sg02_0001__p18965161732218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.09460946094609%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_sg02_0001__p2017153116589">Specifies the number of records that will be returned on each page. The value is from 0 to intmax.</p>
<p id="vpc_sg02_0001__p125192338584"><strong id="vpc_sg02_0001__vpc_api01_0003_b7164124258">limit</strong> can be used together with <strong id="vpc_sg02_0001__vpc_api01_0003_b15985310854">marker</strong>. For details, see the parameter description of <strong id="vpc_sg02_0001__vpc_api01_0003_b193281854847">marker</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="vpc_sg02_0001__section3834086716037"><h4 class="sectiontitle">Request Message</h4><p id="vpc_sg02_0001__p1537861816037">None</p>
</div>
<div class="section" id="vpc_sg02_0001__section6006230416037"><h4 class="sectiontitle">Response Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_sg02_0001__table1547016516037" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_sg02_0001__row2546099716037"><th align="left" class="cellrowborder" valign="top" width="23.169999999999998%" id="mcps1.3.6.2.2.4.1.1"><p id="vpc_sg02_0001__p3614026216037">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.61%" id="mcps1.3.6.2.2.4.1.2"><p id="vpc_sg02_0001__p3446060616037">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.22%" id="mcps1.3.6.2.2.4.1.3"><p id="vpc_sg02_0001__p3726817816037">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_sg02_0001__row841863916037"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.6.2.2.4.1.1 "><p id="vpc_sg02_0001__p5631571516037">security_groups</p>
</td>
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.6.2.2.4.1.2 "><p id="vpc_sg02_0001__p86066502616">Array of <a href="#vpc_sg02_0001__table513726041607">Security Group</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.6.2.2.4.1.3 "><p id="vpc_sg02_0001__p6079210416037">Specifies the security group list. For details, see <a href="#vpc_sg02_0001__table513726041607">Table 3</a>.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__row1081361216185"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.6.2.2.4.1.1 "><p id="vpc_sg02_0001__p281361251816">security_groups_links</p>
</td>
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.6.2.2.4.1.2 "><p id="vpc_sg02_0001__p16813141216189">Array of <a href="#vpc_sg02_0001__table1318194661915">SecurityGroupsLink</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.6.2.2.4.1.3 "><p id="vpc_sg02_0001__p1813612171815">Shows pagination information about security groups.</p>
<p id="vpc_sg02_0001__p23826205208">The value of <strong id="vpc_sg02_0001__b158911474714">rel</strong> will be <strong id="vpc_sg02_0001__b159501414713">next</strong> and that of <strong id="vpc_sg02_0001__b1595114124711">href</strong> will be a link only when <strong id="vpc_sg02_0001__b18596101411471">limit</strong> is used for filtering and the number of resources exceeds the value of <strong id="vpc_sg02_0001__b175961814174716">limit</strong> or 2000 (default value of <strong id="vpc_sg02_0001__b185961014174714">limit</strong>).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_sg02_0001__table513726041607"></a><a name="table513726041607"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_sg02_0001__table513726041607" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_sg02_0001__b842352706145844">Security Group</strong> objects</caption><thead align="left"><tr id="vpc_sg02_0001__row72893461607"><th align="left" class="cellrowborder" valign="top" width="26.669999999999998%" id="mcps1.3.6.3.2.4.1.1"><p id="vpc_sg02_0001__p647825491607"><strong id="vpc_sg02_0001__b74664312719">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.330000000000002%" id="mcps1.3.6.3.2.4.1.2"><p id="vpc_sg02_0001__p245230881607"><strong id="vpc_sg02_0001__b7275337576">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.6.3.2.4.1.3"><p id="vpc_sg02_0001__p4542071607"><strong id="vpc_sg02_0001__b10119113816711">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_sg02_0001__row284118681607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_sg02_0001__p6322881607">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_sg02_0001__p206339641607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_sg02_0001__p538811831607">Specifies the security group ID.</p>
<p id="vpc_sg02_0001__p7631141813810">This parameter is not mandatory when you query security groups.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__row487759591607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_sg02_0001__p499705331607">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_sg02_0001__p26621541607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_sg02_0001__p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_sg02_0001__row356666781607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_sg02_0001__p270644691607">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_sg02_0001__p426717071607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_sg02_0001__p29740751607">Specifies the security group name.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__row5261561607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_sg02_0001__p76095411607">description</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_sg02_0001__p597100051607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_sg02_0001__p40269061607">Provides supplementary information about the security group.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__row141788771607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_sg02_0001__p574773991607">security_group_rules</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_sg02_0001__p263715271607">Array of <a href="#vpc_sg02_0001__table655457801607">Security Group Rule</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_sg02_0001__p577222241607">Specifies the security group rule list. For details, see <a href="#vpc_sg02_0001__table655457801607">Table 4</a>.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__row19560720141817"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_sg02_0001__p870051413911">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_sg02_0001__p15700614790">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_sg02_0001__p8746620183014">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_sg02_0001__row5768162761818"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_sg02_0001__p1953114119914">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_sg02_0001__p595318416919">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_sg02_0001__p1395374115919">Specifies the time (UTC) when the security group is created.</p>
<p id="vpc_sg02_0001__p65980291419">Format: <em id="vpc_sg02_0001__i175318119108">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="vpc_sg02_0001__row4242824111816"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_sg02_0001__p139719548912">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_sg02_0001__p53971154594">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_sg02_0001__p1339713549918">Specifies the time (UTC) when the security group is updated.</p>
<p id="vpc_sg02_0001__p15297192516128">Format: <em id="vpc_sg02_0001__i122011254101">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_sg02_0001__table655457801607"></a><a name="table655457801607"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_sg02_0001__table655457801607" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_sg02_0001__vpc_sg02_0006_b842352706151318">Security Group Rule</strong> objects</caption><thead align="left"><tr id="vpc_sg02_0001__vpc_sg02_0006_row54478641607"><th align="left" class="cellrowborder" valign="top" width="26.669999999999998%" id="mcps1.3.6.4.2.4.1.1"><p id="vpc_sg02_0001__vpc_sg02_0006_p389969021607"><strong id="vpc_sg02_0001__vpc_sg02_0006_b195868418291">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.330000000000002%" id="mcps1.3.6.4.2.4.1.2"><p id="vpc_sg02_0001__vpc_sg02_0006_p36789391607"><strong id="vpc_sg02_0001__vpc_sg02_0006_b582815515290">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.6.4.2.4.1.3"><p id="vpc_sg02_0001__vpc_sg02_0006_p433861031607"><strong id="vpc_sg02_0001__vpc_sg02_0006_b198338642916">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_sg02_0001__vpc_sg02_0006_row134774871607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p269083981607">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p630670281607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p334792201607">Specifies the security group rule ID.</p>
<p id="vpc_sg02_0001__vpc_sg02_0006_p529374054010">This parameter is not mandatory when you query security group rules.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row250554771607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p254411021607">description</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p505368621607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p480145951607">Provides supplementary information about the security group rule.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row569401671607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p115724181607">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p615991711607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p587796621607">Specifies the ID of the belonged security group.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row654332091607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p113008931607">remote_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p170542961607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p141218971607">Specifies the peer ID of the belonged security group.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row9932071607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p657989401607">direction</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p507988391607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p570991491607">Specifies the direction of the traffic for which the security group rule takes effect.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row97529031607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p478834691607">remote_ip_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p622759951607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p146708701607">Specifies the peer IP address segment.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row315033981607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p163656291607">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p628340441607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p99902671607">Specifies the protocol type or the IP protocol number.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row551583771607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p97886331607">port_range_max</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p343603851607">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p188144701607">Specifies the maximum port number. When ICMP is used, the value is the ICMP code.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row456604071607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p630384091607">port_range_min</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p337362901607">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p258562691607">Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type.</p>
<p id="vpc_sg02_0001__vpc_sg02_0006_p5690808615417">When the TCP or UDP protocol is used, both <strong id="vpc_sg02_0001__vpc_sg02_0006_b84235270621055">port_range_max</strong> and <strong id="vpc_sg02_0001__vpc_sg02_0006_b8423527062112">port_range_min</strong> must be specified, and the <strong id="vpc_sg02_0001__vpc_sg02_0006_b43870256421149">port_range_max</strong> value must be greater than the <strong id="vpc_sg02_0001__vpc_sg02_0006_b70589128621159">port_range_min</strong> value.</p>
<p id="vpc_sg02_0001__vpc_sg02_0006_p4241072615417">When the ICMP protocol is used, if you specify the ICMP code (<strong id="vpc_sg02_0001__vpc_sg02_0006_b84235270621317">port_range_max</strong>), you must also specify the ICMP type (<strong id="vpc_sg02_0001__vpc_sg02_0006_b84235270621326">port_range_min</strong>).</p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row360773491607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p364292801607">ethertype</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p339523071607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p34728681607">Specifies the network type.</p>
<p id="vpc_sg02_0001__vpc_sg02_0006_p568898621607">IPv4 and IPv6 are supported.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row532124261607"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p593368391607">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p130282191607">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row226972613121"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p114291339201219">remote_address_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p6429183913122">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><ul id="vpc_sg02_0001__vpc_sg02_0006_ul871718283154"><li id="vpc_sg02_0001__vpc_sg02_0006_vpc_sg01_0001_li106781571627">Specifies the remote IP address group ID.</li><li id="vpc_sg02_0001__vpc_sg02_0006_vpc_sg01_0001_li767815571025">The value is exclusive with parameters <strong id="vpc_sg02_0001__vpc_sg02_0006_vpc_sg01_0001_b1185142797">remote_ip_prefix</strong> and <strong id="vpc_sg02_0001__vpc_sg02_0006_vpc_sg01_0001_b64611932598">remote_group_id</strong>.</li></ul>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row11992111863317"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p169261732143314">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p69311132153317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p13646103310">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row10903153923318"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p6634195714335">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p12638157153319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p1364635713332">Specifies the time (UTC) when the security group rule is created.</p>
<p id="vpc_sg02_0001__vpc_sg02_0006_p65980291419">Format: <em id="vpc_sg02_0001__vpc_sg02_0006_i1034411227245">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="vpc_sg02_0001__vpc_sg02_0006_row1797311427338"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_sg02_0001__vpc_sg02_0006_p1725445103416">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_sg02_0001__vpc_sg02_0006_p192601514345">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_sg02_0001__vpc_sg02_0006_p1127018513343">Specifies the time (UTC) when the security group rule is updated.</p>
<p id="vpc_sg02_0001__vpc_sg02_0006_p19850105451210">Format: <em id="vpc_sg02_0001__vpc_sg02_0006_i1647183316242">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_sg02_0001__table1318194661915"></a><a name="table1318194661915"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_sg02_0001__table1318194661915" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="vpc_sg02_0001__b4549201731416">SecurityGroupsLink</strong> objects</caption><thead align="left"><tr id="vpc_sg02_0001__row12181246101911"><th align="left" class="cellrowborder" valign="top" width="26.87%" id="mcps1.3.6.5.2.4.1.1"><p id="vpc_sg02_0001__p19181646101917">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.41%" id="mcps1.3.6.5.2.4.1.2"><p id="vpc_sg02_0001__p718124661912">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.72%" id="mcps1.3.6.5.2.4.1.3"><p id="vpc_sg02_0001__p719134621911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_sg02_0001__row191974671910"><td class="cellrowborder" valign="top" width="26.87%" headers="mcps1.3.6.5.2.4.1.1 "><p id="vpc_sg02_0001__p1919946151916">href</p>
</td>
<td class="cellrowborder" valign="top" width="23.41%" headers="mcps1.3.6.5.2.4.1.2 "><p id="vpc_sg02_0001__p71994671918">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.72%" headers="mcps1.3.6.5.2.4.1.3 "><p id="vpc_sg02_0001__p1919184631917">Specifies the API link.</p>
</td>
</tr>
<tr id="vpc_sg02_0001__row519846181910"><td class="cellrowborder" valign="top" width="26.87%" headers="mcps1.3.6.5.2.4.1.1 "><p id="vpc_sg02_0001__p519646121916">rel</p>
</td>
<td class="cellrowborder" valign="top" width="23.41%" headers="mcps1.3.6.5.2.4.1.2 "><p id="vpc_sg02_0001__p19191464193">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.72%" headers="mcps1.3.6.5.2.4.1.3 "><p id="vpc_sg02_0001__p101954681914">Specifies the relationship between the API link and the API version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_sg02_0001__section2440368716037"><h4 class="sectiontitle">Example:</h4><p id="vpc_sg02_0001__p144849216418">Example request</p>
<pre class="screen" id="vpc_sg02_0001__screen16359165103317">GET https://{Endpoint}/v2.0/security-groups?limit=1</pre>
</div>
<p id="vpc_sg02_0001__p7206171418415">Example response</p>
<pre class="screen" id="vpc_sg02_0001__screen1643232693320">{
"security_groups": [
{
"id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
"name": "sg-ad3f",
"description": "",
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"security_group_rules": [
{
"id": "d90e55ba-23bd-4d97-b722-8cb6fb485d69",
"direction": "ingress",
"protocol": null,
"ethertype": "IPv4",
"description": null,
"remote_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
"remote_ip_prefix": null,
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"port_range_max": null,
"port_range_min": null,
"security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
"remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249"
},
{
"id": "aecff4d4-9ce9-489c-86a3-803aedec65f7",
"direction": "egress",
"protocol": null,
"ethertype": "IPv4",
"description": null,
"remote_group_id": null,
"remote_ip_prefix": null,
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"port_range_max": null,
"port_range_min": null,
"security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
"remote_address_group_id": null
}
],
"created_at": "2018-09-12T08:24:14",
"updated_at": "2018-09-12T08:24:14"
}
],
"security_groups_links": [
{
"rel": "next",
"href": "https://{Endpoint}/v2.0/security-groups?limit=1&amp;marker=0431c9c5-1660-42e0-8a00-134bec7f03e2"
},
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/security-groups?limit=1&amp;marker=0431c9c5-1660-42e0-8a00-134bec7f03e2&amp;page_reverse=True"
}
]
}</pre>
<div class="section" id="vpc_sg02_0001__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_sg02_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_sg02_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_sg02_0001__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_sg02_0000.html">Security Group</a></div>
</div>
</div>
View Git Blame Copy Permalink