yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
12211d6d9cbd2bfdb18aadc10faed67f3ac77bc2
doc-exports/docs/cfw/api-ref/ListServiceSets.html
qiaoli 9776db0ee8 First version of the CFW API 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiaoli <qiaoli@huawei.com>
Co-committed-by: qiaoli <qiaoli@huawei.com>
2025-01-21 07:59:01 +00:00

367 lines
27 KiB
HTML
Raw Blame History

<a name="ListServiceSets"></a><a name="ListServiceSets"></a>
<h1 class="topictitle1">Obtaining the Service Group List</h1>
<div id="body1708331107508"><div class="section" id="ListServiceSets__section930922523110"><h4 class="sectiontitle">Function</h4><p id="ListServiceSets__p19310925123112">This API is used to obtain the service group list.</p>
</div>
<div class="section" id="ListServiceSets__section1311112573110"><h4 class="sectiontitle">URI</h4><p id="ListServiceSets__p4311025123118">GET /v1/{project_id}/service-sets</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSets__table1031272514313" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListServiceSets__row2312122514313"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListServiceSets__p18313122533115">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListServiceSets__p031319254319">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListServiceSets__p1431312513315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListServiceSets__p1731472516315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSets__row1831232533119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListServiceSets__p83141025203111">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListServiceSets__p231472533110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListServiceSets__p8315425103113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListServiceSets__p1631572583115">Project ID, which can be obtained by calling an API or from the console. For details, see <a href="cfw_02_0015.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSets__table17317725113115" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListServiceSets__row131632519319"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListServiceSets__p173171825173117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListServiceSets__p173179257318">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListServiceSets__p6318925153115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListServiceSets__p1431862553119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSets__row133161625133117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p0318172514314">object_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p1731982573114">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p2031982533113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p16320142517310">Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the <a href="ListFirewallDetail.html">API for querying firewall instances</a>. In the return value, find the ID in <strong id="ListServiceSets__b1832002513118">data.records.protect_objects.object_id</strong> (The period [.] is used to separate different levels of objects). If the value of <strong id="ListServiceSets__b5320162583114">type</strong> is <strong id="ListServiceSets__b1132022510312">0</strong>, the protected object ID belongs to the Internet border. If the value of <strong id="ListServiceSets__b13320625113111">type</strong> is <strong id="ListServiceSets__b17320182519317">1</strong>, the protected object ID belongs to the VPC border. You can obtain the value of <strong id="ListServiceSets__b132015257313">type</strong> from <strong id="ListServiceSets__b032012543116">data.records.protect_objects.type</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="ListServiceSets__row113161257317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p9321202517312">key_word</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p163211825153114">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p5321125193116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p7322162513313">Keyword, which can be the service group name or part of the service group description.</p>
</td>
</tr>
<tr id="ListServiceSets__row113167251311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p12322825133113">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p1432372573116">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p1532362573110">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p832342512318">Number of query records on each page. The value ranges from 1 to 1024.</p>
</td>
</tr>
<tr id="ListServiceSets__row10316172514311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p3324125203118">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p3324122510310">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p173241825153117">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p103251925173111">Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is <strong id="ListServiceSets__b1432502523111">0</strong>.</p>
</td>
</tr>
<tr id="ListServiceSets__row2316825203112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p3325725193119">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p33262258315">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p17326125143113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p7326925173116">Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to <a href="cfw_02_0027.html">Obtaining an Enterprise Project ID</a>. If the enterprise project function is not enabled, the value is <strong id="ListServiceSets__b632712511315">0</strong>.</p>
</td>
</tr>
<tr id="ListServiceSets__row5316122543112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p532702533117">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p132722519316">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p19327152511318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p3328152510312">Firewall ID, which can be obtained by referring to <a href="cfw_02_0028.html">Obtaining a Firewall ID</a>.</p>
</td>
</tr>
<tr id="ListServiceSets__row531616254319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p1232872553112">query_service_set_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p93291125133115">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p10329325153117">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p433042533113">Type of the service group to be queried: <strong id="ListServiceSets__b193301325133114">0</strong> (user-defined service group), <strong id="ListServiceSets__b1633014256314">1</strong> (predefined service group).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListServiceSets__section53304254319"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSets__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListServiceSets__row153301525193116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListServiceSets__p123311725173117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListServiceSets__p33314252318">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListServiceSets__p3332132519317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListServiceSets__p73321325123116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSets__row1633082553112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListServiceSets__p233272511316">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListServiceSets__p13331725203111">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListServiceSets__p1433382553111">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListServiceSets__p14334625163114">User token. You can obtain the token by referring to <a href="cfw_02_0029.html">Obtaining a User Token</a>.</p>
</td>
</tr>
<tr id="ListServiceSets__row1871824417312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListServiceSets__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListServiceSets__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListServiceSets__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListServiceSets__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListServiceSets__section1933492513315"><h4 class="sectiontitle">Response Parameters</h4><p id="ListServiceSets__p20335192517310"><strong id="ListServiceSets__b53352025193112">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSets__response_QueryServiceSetList" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListServiceSets__row933592583110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListServiceSets__p1033611259313">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListServiceSets__p163361425133112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListServiceSets__p0336122563115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSets__row33358258312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListServiceSets__p6337192511314">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListServiceSets__p18337122563115"><a href="#ListServiceSets__response_ServiceSetRecords">ServiceSetRecords</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListServiceSets__p18337152593110">Query the service group list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListServiceSets__response_ServiceSetRecords"></a><a name="response_ServiceSetRecords"></a><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSets__response_ServiceSetRecords" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ServiceSetRecords</caption><thead align="left"><tr id="ListServiceSets__row1333842512317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListServiceSets__p17339925203114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListServiceSets__p433932512314">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListServiceSets__p93401025133119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSets__row2033862553113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSets__p19340152573111">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSets__p634111256318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSets__p634172512314">Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is <strong id="ListServiceSets__b1134102512319">0</strong>.</p>
</td>
</tr>
<tr id="ListServiceSets__row13381525133115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSets__p143429255314">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSets__p83421025123113">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSets__p23421255314">Number of records displayed on each page. The value ranges from 1 to 1024.</p>
</td>
</tr>
<tr id="ListServiceSets__row1033802514313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSets__p193439258314">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSets__p334382514312">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSets__p934318259318">Query the total number of service groups.</p>
</td>
</tr>
<tr id="ListServiceSets__row193381225183112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSets__p16344192519312">records</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSets__p16344122518317">Array of <a href="#ListServiceSets__response_ServiceSet">ServiceSet</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSets__p123445257317">Service group list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListServiceSets__response_ServiceSet"></a><a name="response_ServiceSet"></a><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSets__response_ServiceSet" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ServiceSet</caption><thead align="left"><tr id="ListServiceSets__row1934592519319"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListServiceSets__p143461025113116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListServiceSets__p4346162523118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListServiceSets__p1334792514311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSets__row103451825153110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p23473258312">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p15347825133118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p4348425183113">Service group ID.</p>
</td>
</tr>
<tr id="ListServiceSets__row5345102533114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p734822512314">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p103481225193114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p934952517315">Service group name.</p>
</td>
</tr>
<tr id="ListServiceSets__row1534542513319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p113495256317">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p16349132583111">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p1335072583117">Service group description.</p>
</td>
</tr>
<tr id="ListServiceSets__row113451825123114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p1935062593115">service_set_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p3350142513318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p7351142503116">Service group type: <strong id="ListServiceSets__b15351025153110">0</strong> (user-defined service group), <strong id="ListServiceSets__b15351525133116">1</strong> (common web service), <strong id="ListServiceSets__b6351325123113">2</strong> (common remote login and ping), or <strong id="ListServiceSets__b173516251315">3</strong> (common database).</p>
</td>
</tr>
<tr id="ListServiceSets__row17345112513119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p13351172518314">ref_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p12352182563113">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p335252543119">Number of times a service group is referenced by rules.</p>
</td>
</tr>
<tr id="ListServiceSets__row153456252317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p3352122563118">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p1835319258311">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p73535251311">Project ID.</p>
</td>
</tr>
<tr id="ListServiceSets__row193451225113111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p1335432583117">protocols</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p5354192503110">Array of integers</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p1335515256319">Protocol list. Protocol type: <strong id="ListServiceSets__b935511254316">6</strong> (TCP), <strong id="ListServiceSets__b11355172553119">17</strong> (UDP), <strong id="ListServiceSets__b635522513314">1</strong> (ICMP), <strong id="ListServiceSets__b835516250314">58</strong> (ICMPv6), or <strong id="ListServiceSets__b83558252317">-1</strong> (any). It cannot be left blank when <strong id="ListServiceSets__b11355102516318">type</strong> is set to <strong id="ListServiceSets__b193551025173114">0</strong> (manual).</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListServiceSets__p13355925113113"><strong id="ListServiceSets__b1235615253311">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSets__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListServiceSets__row835622516317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListServiceSets__p1535715255315">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListServiceSets__p1235711252315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListServiceSets__p8357192583114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSets__row2356825143115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListServiceSets__p143581125173118">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListServiceSets__p1535822512314">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListServiceSets__p7358102593111">Error code.</p>
</td>
</tr>
<tr id="ListServiceSets__row16356142583112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListServiceSets__p1835932510311">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListServiceSets__p2359625163118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListServiceSets__p11359102518312">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListServiceSets__section15360125153115"><h4 class="sectiontitle">Example Requests</h4><p id="ListServiceSets__p113601125143117">Query the service group list on the first page of protected object a37bb4eb-c49e-4e88-bf77-944a75b0ce8a in project 2349ba469daf4b7daf268bb0261d18b0.</p>
<pre class="screen" id="ListServiceSets__screen0360162513119">https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/service-sets?object_id=a37bb4eb-c49e-4e88-bf77-944a75b0ce8a&amp;limit=10&amp;offset=0</pre>
</div>
<div class="section" id="ListServiceSets__section1536162511318"><h4 class="sectiontitle">Example Responses</h4><p id="ListServiceSets__p183611525173113"><strong id="ListServiceSets__b4361125113119">Status code: 200</strong></p>
<p id="ListServiceSets__p123621525123119">Return value for the service group list query.</p>
<pre class="screen" id="ListServiceSets__screen3363102593117">{
"data" : {
"limit" : 50,
"offset" : 0,
"records" : [ {
"name" : "test",
"project_id" : "2349ba469daf4b7daf268bb0261d18b0",
"protocols" : [ 6 ],
"ref_count" : 2,
"service_set_type" : 0,
"set_id" : "6f475bad-5d33-45d1-98f8-c79f2f308d5a"
} ],
"total" : 1
}
}</pre>
<p id="ListServiceSets__p2366172511313"><strong id="ListServiceSets__b15366425113114">Status code: 400</strong></p>
<p id="ListServiceSets__p10366102563119">Bad Request</p>
<pre class="screen" id="ListServiceSets__screen193671425183113">{
"error_code" : "CFW.0020016",
"error_msg" : "Incorrect instance status."
}</pre>
</div>
<div class="section" id="ListServiceSets__section551116256319"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSets__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListServiceSets__row11398625203111"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListServiceSets__p15121225193120">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListServiceSets__p9512125183110">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSets__row11398142533112"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p5512725103115">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p3512225183110">Return value for the service group list query.</p>
</td>
</tr>
<tr id="ListServiceSets__row139832518319"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p145121325203117">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p251272513119">Bad Request</p>
</td>
</tr>
<tr id="ListServiceSets__row1039862593119"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p155128254312">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p3512172517312">Unauthorized</p>
</td>
</tr>
<tr id="ListServiceSets__row1039818254313"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p151212256314">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p1151322516319">Forbidden</p>
</td>
</tr>
<tr id="ListServiceSets__row18398132520316"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p14513102583112">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p75131825143110">Not Found</p>
</td>
</tr>
<tr id="ListServiceSets__row5398132518314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p551382510314">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p16513122543110">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListServiceSets__section851342517314"><h4 class="sectiontitle">Error Codes</h4><p id="ListServiceSets__p12513132511317">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000005.html">Service Group Management</a></div>
</div>
</div>
View Git Blame Copy Permalink