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

397 lines
35 KiB
HTML
Raw Blame History

<a name="vpc_apiv3_0011"></a><a name="vpc_apiv3_0011"></a>
<h1 class="topictitle1">Querying Security Groups</h1>
<div id="body1708331107508"><div class="section" id="vpc_apiv3_0011__section728617211486"><h4 class="sectiontitle">Function</h4><p id="vpc_apiv3_0011__p12866211818">After a security group is created, you can call this API to query all information about the security group, including the name, ID, and description.</p>
</div>
<div class="section" id="vpc_apiv3_0011__section152867211384"><h4 class="sectiontitle">Constraints</h4><p id="vpc_apiv3_0011__p142861321084">You can query all security groups under your account. A maximum of 2,000 records can be returned for each query. If the number of records exceeds 2,000, the pagination marker will be returned.</p>
</div>
<div class="section" id="vpc_apiv3_0011__section42872021385"><h4 class="sectiontitle">URI</h4><p id="vpc_apiv3_0011__p428716217815">GET /v3/{project_id}/vpc/security-groups</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0011__table7287321486" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="vpc_apiv3_0011__row162873212819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="vpc_apiv3_0011__p162872211381">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_0011__p12873211187">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_0011__p52879211982">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_0011__p132871521384">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0011__row4287162118812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0011__p428892118816">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0011__p1728820218816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0011__p1828882118816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="vpc_apiv3_0011__ul4288621382"><li id="vpc_apiv3_0011__li162887218811"><p id="vpc_apiv3_0011__p3288921185"><a name="vpc_apiv3_0011__li162887218811"></a><a name="li162887218811"></a>Definition: ID of the project that a security group belongs to.</p>
</li><li id="vpc_apiv3_0011__li6288821585"><p id="vpc_apiv3_0011__p1928818212811"><a name="vpc_apiv3_0011__li6288821585"></a><a name="li6288821585"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0011__table162891621986" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="vpc_apiv3_0011__row182881921984"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="vpc_apiv3_0011__p5289621988">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="vpc_apiv3_0011__p328918211983">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="vpc_apiv3_0011__p12289172119815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="vpc_apiv3_0011__p14289142117811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0011__row1728813214818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="vpc_apiv3_0011__p328920211183">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="vpc_apiv3_0011__p128910217811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="vpc_apiv3_0011__p92891721880">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="vpc_apiv3_0011__ul32895214815"><li id="vpc_apiv3_0011__li122891121482"><p id="vpc_apiv3_0011__p0289421487"><a name="vpc_apiv3_0011__li122891121482"></a><a name="li122891121482"></a>Definition: Number of resources returned on each page.</p>
</li><li id="vpc_apiv3_0011__li72901211681"><p id="vpc_apiv3_0011__p132907212813"><a name="vpc_apiv3_0011__li72901211681"></a><a name="li72901211681"></a>Range: 0-2000</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row14288132120819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="vpc_apiv3_0011__p829016211813">marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="vpc_apiv3_0011__p20290721284">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="vpc_apiv3_0011__p10290152110816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="vpc_apiv3_0011__ul1129042115816"><li id="vpc_apiv3_0011__li1029062120816"><p id="vpc_apiv3_0011__p629015215819"><a name="vpc_apiv3_0011__li1029062120816"></a><a name="li1029062120816"></a>Definition: ID of the resource from which the pagination query starts. If the parameter is left blank, only resources on the first page are queried.</p>
</li><li id="vpc_apiv3_0011__li1129019211584"><p id="vpc_apiv3_0011__p102901621287"><a name="vpc_apiv3_0011__li1129019211584"></a><a name="li1129019211584"></a>Range: Security group ID.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row52888211484"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="vpc_apiv3_0011__p142904211884">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="vpc_apiv3_0011__p1529002114819">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="vpc_apiv3_0011__p102909212816">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="vpc_apiv3_0011__ul32906211986"><li id="vpc_apiv3_0011__li12902214817"><p id="vpc_apiv3_0011__p11290621285"><a name="vpc_apiv3_0011__li12902214817"></a><a name="li12902214817"></a>Definition: ID of a security group. This field can be used to precisely filter security groups. Multiple IDs can be specified for filtering.</p>
</li><li id="vpc_apiv3_0011__li92901821988"><p id="vpc_apiv3_0011__p1290202112819"><a name="vpc_apiv3_0011__li92901821988"></a><a name="li92901821988"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row928819211183"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="vpc_apiv3_0011__p1229015214810">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="vpc_apiv3_0011__p529011211189">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="vpc_apiv3_0011__p13290121283">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="vpc_apiv3_0011__ul029110216816"><li id="vpc_apiv3_0011__li11291182114812"><p id="vpc_apiv3_0011__p12911621988"><a name="vpc_apiv3_0011__li11291182114812"></a><a name="li11291182114812"></a>Definition: Name of a security group. This field can be used to precisely filter security groups. Multiple names can be specified for filtering.</p>
</li><li id="vpc_apiv3_0011__li229117211788"><p id="vpc_apiv3_0011__p12917213815"><a name="vpc_apiv3_0011__li229117211788"></a><a name="li229117211788"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row1328817213813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="vpc_apiv3_0011__p10291321785">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="vpc_apiv3_0011__p629152119810">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="vpc_apiv3_0011__p192911321880">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="vpc_apiv3_0011__ul142911121186"><li id="vpc_apiv3_0011__li2029119216820"><p id="vpc_apiv3_0011__p429112211982"><a name="vpc_apiv3_0011__li2029119216820"></a><a name="li2029119216820"></a>Definition: Description of a security group. This field can be used to precisely filter security groups. Multiple descriptions can be specified for filtering.</p>
</li><li id="vpc_apiv3_0011__li1429118211788"><p id="vpc_apiv3_0011__p1629118214814"><a name="vpc_apiv3_0011__li1429118211788"></a><a name="li1429118211788"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row1289921582"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="vpc_apiv3_0011__p5291821385">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="vpc_apiv3_0011__p1529142110811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="vpc_apiv3_0011__p1829111211189">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="vpc_apiv3_0011__ul1529115211381"><li id="vpc_apiv3_0011__li2029111211819"><p id="vpc_apiv3_0011__p1629114211583"><a name="vpc_apiv3_0011__li2029111211819"></a><a name="li2029111211819"></a>Definition: ID of the enterprise project that a security group belongs to. This field can be used to filter the security groups associated with an enterprise project.</p>
</li><li id="vpc_apiv3_0011__li202915211882"><p id="vpc_apiv3_0011__p152913211982"><a name="vpc_apiv3_0011__li202915211882"></a><a name="li202915211882"></a>Range:</p>
<ul id="vpc_apiv3_0011__ul8292172116811"><li id="vpc_apiv3_0011__li6292182113810"><p id="vpc_apiv3_0011__p4292221380"><a name="vpc_apiv3_0011__li6292182113810"></a><a name="li6292182113810"></a>The value is <strong id="vpc_apiv3_0011__b529217216818">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). <strong id="vpc_apiv3_0011__b52923212083">0</strong> indicates the default enterprise project.</p>
</li><li id="vpc_apiv3_0011__li20292521182"><p id="vpc_apiv3_0011__p1829272118816"><a name="vpc_apiv3_0011__li20292521182"></a><a name="li20292521182"></a>To obtain the security groups associated with all enterprise projects that a user has permissions to view, specify <strong id="vpc_apiv3_0011__b5292221386">all_granted_eps</strong>.</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row1828992119816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="vpc_apiv3_0011__p229216211888">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="vpc_apiv3_0011__p529232119813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="vpc_apiv3_0011__p829220218810">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="vpc_apiv3_0011__ul129210211786"><li id="vpc_apiv3_0011__li329215217817"><p id="vpc_apiv3_0011__p182924217818"><a name="vpc_apiv3_0011__li329215217817"></a><a name="li329215217817"></a>Definition: ID of the project that a security group belongs to.</p>
</li><li id="vpc_apiv3_0011__li10292202113814"><p id="vpc_apiv3_0011__p32929211985"><a name="vpc_apiv3_0011__li10292202113814"></a><a name="li10292202113814"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0011__section112930211488"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_apiv3_0011__p729362117810">None</p>
</div>
<div class="section" id="vpc_apiv3_0011__section1829342118811"><h4 class="sectiontitle">Response Parameters</h4><p id="vpc_apiv3_0011__p129316211485"><strong id="vpc_apiv3_0011__b152931621888">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0011__response_ListSecurityGroupsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="vpc_apiv3_0011__row929313211820"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_apiv3_0011__p32945211387">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_apiv3_0011__p11294172119812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_apiv3_0011__p2029418211784">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0011__row112938210817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiv3_0011__p172946211583">security_groups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiv3_0011__p42942211810">Array of <a href="#vpc_apiv3_0011__response_SecurityGroup">SecurityGroup</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiv3_0011__ul102945211786"><li id="vpc_apiv3_0011__li162947216815"><p id="vpc_apiv3_0011__p1294122111811"><a name="vpc_apiv3_0011__li162947216815"></a><a name="li162947216815"></a>Definition: Response body for querying security groups.</p>
</li><li id="vpc_apiv3_0011__li1629417215810"><p id="vpc_apiv3_0011__p172941211811"><a name="vpc_apiv3_0011__li1629417215810"></a><a name="li1629417215810"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row142930212088"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiv3_0011__p529417213813">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiv3_0011__p9294152116817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiv3_0011__ul1229417211813"><li id="vpc_apiv3_0011__li029492110811"><p id="vpc_apiv3_0011__p1429415212813"><a name="vpc_apiv3_0011__li029492110811"></a><a name="li029492110811"></a>Definition: Request ID.</p>
</li><li id="vpc_apiv3_0011__li19294142117815"><p id="vpc_apiv3_0011__p1294142118815"><a name="vpc_apiv3_0011__li19294142117815"></a><a name="li19294142117815"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row122934218813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiv3_0011__p6294142119812">page_info</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiv3_0011__p429411211588"><a href="#vpc_apiv3_0011__response_PageInfo">PageInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiv3_0011__ul929512116813"><li id="vpc_apiv3_0011__li72954215820"><p id="vpc_apiv3_0011__p1029514214815"><a name="vpc_apiv3_0011__li72954215820"></a><a name="li72954215820"></a>Definition: Pagination information.</p>
</li><li id="vpc_apiv3_0011__li122959211683"><p id="vpc_apiv3_0011__p192951921787"><a name="vpc_apiv3_0011__li122959211683"></a><a name="li122959211683"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0011__response_SecurityGroup"></a><a name="response_SecurityGroup"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0011__response_SecurityGroup" frame="border" border="1" rules="all"><caption><b>Table 4 </b>SecurityGroup</caption><thead align="left"><tr id="vpc_apiv3_0011__row1629592112819"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="vpc_apiv3_0011__p202962211687">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.2"><p id="vpc_apiv3_0011__p10296192119812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="vpc_apiv3_0011__p1629611211688">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0011__row029542116810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0011__p152960211981">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0011__p7296721484">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0011__ul10296162117817"><li id="vpc_apiv3_0011__li1129618211187"><p id="vpc_apiv3_0011__p529611211780"><a name="vpc_apiv3_0011__li1129618211187"></a><a name="li1129618211187"></a>Definition: ID of a security group. After a security group is created, a security group ID is generated, which uniquely identifies the security group.</p>
</li><li id="vpc_apiv3_0011__li162965213815"><p id="vpc_apiv3_0011__p22961021584"><a name="vpc_apiv3_0011__li162965213815"></a><a name="li162965213815"></a>Range: The value is in UUID format with hyphens (-).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row17295321884"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0011__p929618211889">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0011__p4296172111818">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0011__ul42964217810"><li id="vpc_apiv3_0011__li11297192116816"><p id="vpc_apiv3_0011__p18297621180"><a name="vpc_apiv3_0011__li11297192116816"></a><a name="li11297192116816"></a>Definition: Name of a security group.</p>
</li><li id="vpc_apiv3_0011__li4297142118814"><p id="vpc_apiv3_0011__p1429732117816"><a name="vpc_apiv3_0011__li4297142118814"></a><a name="li4297142118814"></a>Range: The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row10295152112811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0011__p15297122111818">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0011__p20297112114811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0011__ul182971214818"><li id="vpc_apiv3_0011__li129712113811"><p id="vpc_apiv3_0011__p1529752112810"><a name="vpc_apiv3_0011__li129712113811"></a><a name="li129712113811"></a>Definition: Description of a security group.</p>
</li><li id="vpc_apiv3_0011__li15297162110815"><p id="vpc_apiv3_0011__p62971021383"><a name="vpc_apiv3_0011__li15297162110815"></a><a name="li15297162110815"></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_0011__row142954213818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0011__p1629714215817">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0011__p152971221681">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0011__ul72973211389"><li id="vpc_apiv3_0011__li529792115811"><p id="vpc_apiv3_0011__p529711211787"><a name="vpc_apiv3_0011__li529792115811"></a><a name="li529792115811"></a>Definition: ID of the project that a security group belongs to.</p>
</li><li id="vpc_apiv3_0011__li12971821182"><p id="vpc_apiv3_0011__p20297192115811"><a name="vpc_apiv3_0011__li12971821182"></a><a name="li12971821182"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row729542115818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0011__p029717211586">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0011__p92981421482">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0011__ul172982211884"><li id="vpc_apiv3_0011__li132982211084"><p id="vpc_apiv3_0011__p152988218810"><a name="vpc_apiv3_0011__li132982211084"></a><a name="li132982211084"></a>Definition: Time when a security group was created.</p>
</li><li id="vpc_apiv3_0011__li1329810211783"><p id="vpc_apiv3_0011__p32986211186"><a name="vpc_apiv3_0011__li1329810211783"></a><a name="li1329810211783"></a>Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row1829518213816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0011__p2029818211583">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0011__p152981021982">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0011__ul1529832117813"><li id="vpc_apiv3_0011__li112988216815"><p id="vpc_apiv3_0011__p229892117818"><a name="vpc_apiv3_0011__li112988216815"></a><a name="li112988216815"></a>Definition: Time when a security group was updated.</p>
</li><li id="vpc_apiv3_0011__li2029842113810"><p id="vpc_apiv3_0011__p14298172118811"><a name="vpc_apiv3_0011__li2029842113810"></a><a name="li2029842113810"></a>Range: UTC time in the format of yyyy-MM-ddTHH:mm:ssZ</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row7295721581"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0011__p729817216812">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0011__p14298182112814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0011__ul112981321888"><li id="vpc_apiv3_0011__li7298172119816"><p id="vpc_apiv3_0011__p1429810211082"><a name="vpc_apiv3_0011__li7298172119816"></a><a name="li7298172119816"></a>Definition: ID of the enterprise project that a security group belongs to.</p>
</li><li id="vpc_apiv3_0011__li11298122114817"><p id="vpc_apiv3_0011__p202983210816"><a name="vpc_apiv3_0011__li11298122114817"></a><a name="li11298122114817"></a>Range: The value is <strong id="vpc_apiv3_0011__b16298162111810">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). <strong id="vpc_apiv3_0011__b1429814211817">0</strong> indicates the default enterprise project.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row629592114814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0011__p102981421183">tags</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0011__p18299132120812">Array of <a href="#vpc_apiv3_0011__response_ResponseTag">ResponseTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0011__ul192995216820"><li id="vpc_apiv3_0011__li429918211686"><p id="vpc_apiv3_0011__p72997211180"><a name="vpc_apiv3_0011__li429918211686"></a><a name="li429918211686"></a>Definition: Tags of a security group, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects.</p>
</li><li id="vpc_apiv3_0011__li1629916211681"><p id="vpc_apiv3_0011__p16299102111812"><a name="vpc_apiv3_0011__li1629916211681"></a><a name="li1629916211681"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0011__response_ResponseTag"></a><a name="response_ResponseTag"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0011__response_ResponseTag" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResponseTag</caption><thead align="left"><tr id="vpc_apiv3_0011__row72996213818"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="vpc_apiv3_0011__p13300182119810">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.2"><p id="vpc_apiv3_0011__p43008217810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.2.4.1.3"><p id="vpc_apiv3_0011__p11300021981">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0011__row113001521580"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="vpc_apiv3_0011__p43007211080">key</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="vpc_apiv3_0011__p3300192110813">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><ul id="vpc_apiv3_0011__ul3585326104"><li id="vpc_apiv3_0011__li145851921103"><p id="vpc_apiv3_0011__p65857241011"><a name="vpc_apiv3_0011__li145851921103"></a><a name="li145851921103"></a>Definition: Tag key.</p>
</li><li id="vpc_apiv3_0011__li4585622108"><p id="vpc_apiv3_0011__p158592191010"><a name="vpc_apiv3_0011__li4585622108"></a><a name="li4585622108"></a>Range:</p>
<ul id="vpc_apiv3_0011__ul1058511241010"><li id="vpc_apiv3_0011__li0585102141010"><p id="vpc_apiv3_0011__p1158519211011"><a name="vpc_apiv3_0011__li0585102141010"></a><a name="li0585102141010"></a>Each key can contain up to 36 Unicode characters and cannot be left blank.</p>
</li><li id="vpc_apiv3_0011__li155853212101"><p id="vpc_apiv3_0011__p185857291017"><a name="vpc_apiv3_0011__li155853212101"></a><a name="li155853212101"></a>Each key value of a resource must be unique.</p>
</li><li id="vpc_apiv3_0011__li3585025105"><p id="vpc_apiv3_0011__p2586102171014"><a name="vpc_apiv3_0011__li3585025105"></a><a name="li3585025105"></a>The value can contain:</p>
<ul id="vpc_apiv3_0011__ul1358618271019"><li id="vpc_apiv3_0011__li658611215104"><p id="vpc_apiv3_0011__p17586192201013"><a name="vpc_apiv3_0011__li658611215104"></a><a name="li658611215104"></a>Letters</p>
</li><li id="vpc_apiv3_0011__li6586102191017"><p id="vpc_apiv3_0011__p658616271010"><a name="vpc_apiv3_0011__li6586102191017"></a><a name="li6586102191017"></a>Digits</p>
</li><li id="vpc_apiv3_0011__li758619218107"><p id="vpc_apiv3_0011__p558618214106"><a name="vpc_apiv3_0011__li758619218107"></a><a name="li758619218107"></a>Special characters: underscores (_) ,at signs (@), and hyphens (-)</p>
</li></ul>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row1430012211684"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="vpc_apiv3_0011__p1730142114819">value</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="vpc_apiv3_0011__p630111214813">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><ul id="vpc_apiv3_0011__ul10586625104"><li id="vpc_apiv3_0011__li7586172161016"><p id="vpc_apiv3_0011__p7586102121011"><a name="vpc_apiv3_0011__li7586172161016"></a><a name="li7586172161016"></a>Definition: Tag value.</p>
</li><li id="vpc_apiv3_0011__li458612213107"><p id="vpc_apiv3_0011__p185861261014"><a name="vpc_apiv3_0011__li458612213107"></a><a name="li458612213107"></a>Range:</p>
<ul id="vpc_apiv3_0011__ul1058622161018"><li id="vpc_apiv3_0011__li35861222107"><p id="vpc_apiv3_0011__p19586722108"><a name="vpc_apiv3_0011__li35861222107"></a><a name="li35861222107"></a>Each value can contain up to 43 Unicode characters and can be left blank.</p>
</li><li id="vpc_apiv3_0011__li45861423105"><p id="vpc_apiv3_0011__p55864231017"><a name="vpc_apiv3_0011__li45861423105"></a><a name="li45861423105"></a>The value can contain:</p>
<ul id="vpc_apiv3_0011__ul13586102131015"><li id="vpc_apiv3_0011__li85865271019"><p id="vpc_apiv3_0011__p1958632151014"><a name="vpc_apiv3_0011__li85865271019"></a><a name="li85865271019"></a>Letters</p>
</li><li id="vpc_apiv3_0011__li758613211016"><p id="vpc_apiv3_0011__p458617211106"><a name="vpc_apiv3_0011__li758613211016"></a><a name="li758613211016"></a>Digits</p>
</li><li id="vpc_apiv3_0011__li1758614241017"><p id="vpc_apiv3_0011__p135867215104"><a name="vpc_apiv3_0011__li1758614241017"></a><a name="li1758614241017"></a>Special characters: underscore (_), at signs (@), and hyphen (-)</p>
</li></ul>
</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0011__response_PageInfo"></a><a name="response_PageInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0011__response_PageInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PageInfo</caption><thead align="left"><tr id="vpc_apiv3_0011__row1830222111814"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="vpc_apiv3_0011__p73027211181">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.2"><p id="vpc_apiv3_0011__p130211218815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.2.4.1.3"><p id="vpc_apiv3_0011__p1230219214815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0011__row14302122110818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="vpc_apiv3_0011__p33021221281">previous_marker</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="vpc_apiv3_0011__p15302102112818">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><ul id="vpc_apiv3_0011__ul123026212085"><li id="vpc_apiv3_0011__li1630218214815"><p id="vpc_apiv3_0011__p203028211086"><a name="vpc_apiv3_0011__li1630218214815"></a><a name="li1630218214815"></a>Definition: The first record on the current page.</p>
</li><li id="vpc_apiv3_0011__li6302162110815"><p id="vpc_apiv3_0011__p930218216814"><a name="vpc_apiv3_0011__li6302162110815"></a><a name="li6302162110815"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row2302121984"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="vpc_apiv3_0011__p133021621686">current_count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="vpc_apiv3_0011__p63035211284">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><ul id="vpc_apiv3_0011__ul1830312211388"><li id="vpc_apiv3_0011__li4303221288"><p id="vpc_apiv3_0011__p830311211986"><a name="vpc_apiv3_0011__li4303221288"></a><a name="li4303221288"></a>Definition: Total number of records on the current page.</p>
</li><li id="vpc_apiv3_0011__li153038211686"><p id="vpc_apiv3_0011__p23038211083"><a name="vpc_apiv3_0011__li153038211686"></a><a name="li153038211686"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0011__row7302821984"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="vpc_apiv3_0011__p1630319211488">next_marker</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="vpc_apiv3_0011__p330312117812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><ul id="vpc_apiv3_0011__ul193031521484"><li id="vpc_apiv3_0011__li133035210818"><p id="vpc_apiv3_0011__p830320219810"><a name="vpc_apiv3_0011__li133035210818"></a><a name="li133035210818"></a>Definition: The last record on the current page. The parameter <strong id="vpc_apiv3_0011__b630352115819">next_marker</strong> does not exist if the page is the last one.</p>
</li><li id="vpc_apiv3_0011__li143031821282"><p id="vpc_apiv3_0011__p15303112111820"><a name="vpc_apiv3_0011__li143031821282"></a><a name="li143031821282"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0011__section930312211487"><h4 class="sectiontitle">Example Requests</h4><p id="vpc_apiv3_0011__p83031121388">Querying security groups</p>
<pre class="screen" id="vpc_apiv3_0011__screen153039211818">GET https://{Endpoint}/v3/{project_id}/vpc/security-groups</pre>
</div>
<div class="section" id="vpc_apiv3_0011__section330310211484"><h4 class="sectiontitle">Example Responses</h4><p id="vpc_apiv3_0011__p2030317219817"><strong id="vpc_apiv3_0011__b1730310214812">Status code: 200</strong></p>
<p id="vpc_apiv3_0011__p23038211814">Normal response to the GET operation. For more status codes, see <a href="vpc_api_0002.html">Status Codes</a>.</p>
<pre class="screen" id="vpc_apiv3_0011__screen13304142116811">{
"request_id" : "d31cb32ca06f3c1a294fa24e6cbc5a56",
"security_groups" : [ {
"id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
"name" : "sg-test",
"project_id" : "060576782980d5762f9ec014dd2f1148",
"description" : "test",
"enterprise_project_id" : 0,
"created_at" : "2019-10-16T11:11:14.000+00:00",
"updated_at" : "2020-03-25T10:53:46.000+00:00",
"tags" : [ ]
}, {
"id" : "0b8cb773-197c-4c91-94f1-e051f0563e5a",
"name" : "test-sg",
"project_id" : "060576782980d5762f9ec014dd2f1148",
"description" : "The security group is for general-purpose web servers and includes default rules that allow all inbound ICMP traffic and allow inbound traffic on ports 22, 3389, 80, and 443. This security group is suitable for ECSs that require remote login, public network ping, and website services.",
"enterprise_project_id" : 0,
"created_at" : "2019-12-03T09:02:11.000+00:00",
"updated_at" : "2019-12-03T09:02:11.000+00:00",
"tags" : [ ]
} ],
"page_info" : {
"previous_marker" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
"current_count" : 2
}
}</pre>
</div>
<div class="section" id="vpc_apiv3_0011__section104491021083"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0011__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="vpc_apiv3_0011__row113053214810"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="vpc_apiv3_0011__p1944952114818">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="vpc_apiv3_0011__p12449132113812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0011__row730511219812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="vpc_apiv3_0011__p12449192113811">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="vpc_apiv3_0011__p944932113820">Normal response to the GET operation. For more status codes, see <a href="vpc_api_0002.html">Status Codes</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0011__section10449142114818"><h4 class="sectiontitle">Error Codes</h4><p id="vpc_apiv3_0011__p184491221184">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_0009.html">Security Group</a></div>
</div>
</div>
View Git Blame Copy Permalink