forked from docs/doc-exports
372 lines
26 KiB
HTML
372 lines
26 KiB
HTML
<a name="ListServiceSets"></a><a name="ListServiceSets"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining the Service Set List</h1>
|
|
<div id="body112917473515"><div class="section" id="ListServiceSets__section3291444354"><h4 class="sectiontitle">Function</h4><p id="ListServiceSets__p3292346350">This API is used to obtain the service group list.</p>
|
|
</div>
|
|
<div class="section" id="ListServiceSets__section629310410355"><h4 class="sectiontitle">URI</h4><p id="ListServiceSets__p329474193510">GET /v1/{project_id}/service-sets</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSets__table629574123510" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListServiceSets__row102941144352"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListServiceSets__p102950416357">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListServiceSets__p329584183513">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListServiceSets__p152961547356">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListServiceSets__p629610463515">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceSets__row529411410355"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListServiceSets__p16297154113517">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListServiceSets__p529724123519">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListServiceSets__p729711453510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListServiceSets__p1629864193519">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSets__table730094153514" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListServiceSets__row92982048356"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListServiceSets__p1330084193518">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListServiceSets__p23001945357">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListServiceSets__p33015403514">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListServiceSets__p123011410358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceSets__row3298343352"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p1930117463516">object_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p93027483516">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p1630218493514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p73030419351">Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row1329954113510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p1330315463513">key_word</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p530311414357">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p1330454103514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p43041147359">Keyword</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row1829964103518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p113044443517">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p930554183520">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p33050463518">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p1630624153516">Number of queries on each page, in the range 1-1024</p>
|
|
<p id="ListServiceSets__p23067403518">Minimum: <strong id="ListServiceSets__b17306134193515">1</strong></p>
|
|
<p id="ListServiceSets__p203061344356">Maximum: <strong id="ListServiceSets__b830711413354">1024</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row172992413351"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p7307144123510">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p153075443516">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p13308204173518">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p9308641359">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__b6308345351">0</strong>.</p>
|
|
<p id="ListServiceSets__p1430814420352">Minimum: <strong id="ListServiceSets__b33091340359">0</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row729915493513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p530920417358">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p1230917417354">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p17310104153512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p113101540356">Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row62998453517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p931144183516">fw_instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSets__p131112417358">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p931134103512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p8312440351">Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row82997418359"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSets__p113125417350">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__p14312194163510">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSets__p23136417351">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSets__p1313184173513">Query service set type, 0 means custom define service set, 1 means predefine service set.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListServiceSets__section73131548355"><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__row73141244353"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListServiceSets__p1531514410351">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListServiceSets__p1831584133515">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListServiceSets__p1531615417354">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListServiceSets__p12316154173515">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceSets__row133142423512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListServiceSets__p14316104183510">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListServiceSets__p10317543355">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListServiceSets__p1131724183520">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListServiceSets__p193171543352">User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListServiceSets__section1431814463510"><h4 class="sectiontitle">Response Parameters</h4><p id="ListServiceSets__p1631816412356"><strong id="ListServiceSets__b1931911473510">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__row231912493513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListServiceSets__p163204411357">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListServiceSets__p132034183515">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListServiceSets__p1321134163511">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceSets__row93190414358"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListServiceSets__p1032104113511">data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListServiceSets__p173227411353"><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__p9322049351">QueryServiceSetResponse</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__row19323144113515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListServiceSets__p8324124193515">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListServiceSets__p732412403511">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListServiceSets__p133256413519">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceSets__row93231420359"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSets__p143251941359">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSets__p1432611415356">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSets__p1432610453514">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__b93260416354">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row1432310412357"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSets__p1632617453516">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSets__p123274413520">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSets__p23271641356">Number of records displayed on each page, in the range 1-1024</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row153239410355"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSets__p1327348353">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSets__p163286483517">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSets__p143281412357">Total number of records queried</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row63231646359"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSets__p103290483511">records</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSets__p1432910416358">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__p123293473515">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__row63301244358"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListServiceSets__p1633112416355">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListServiceSets__p733124153514">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListServiceSets__p43321744359">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceSets__row1133015418351"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p17332114183512">set_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p15332749358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p16333642358">Service group ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row15330154153515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p533316463517">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p233414418355">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p83355414350">Name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row3330164163511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p733516403510">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p9336104133512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p17336114123512">Description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row193303420357"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p113377417356">service_set_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p133719420356">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p19337446358">Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row633011423519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p13338174133518">ref_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p103381741357">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p9339154173515">Reference count</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row73301641356"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p13391493513">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p03391418351">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p133408483513">Status</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row2330194153510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p1334014415354">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p13401842356">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p63417433511">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row633017413359"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceSets__p153419416351">protocols</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceSets__p634212453512">Array of integers</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceSets__p163421941358">Protocols</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ListServiceSets__p143439417352"><strong id="ListServiceSets__b113434412352">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__row19343144163511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListServiceSets__p15344154123520">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListServiceSets__p4345648350">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListServiceSets__p8345194193517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceSets__row1343641358"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListServiceSets__p15345164153514">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListServiceSets__p5346194123516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListServiceSets__p63471547351">Error code</p>
|
|
<p id="ListServiceSets__p834718419354">Minimum: <strong id="ListServiceSets__b1334717414357">8</strong></p>
|
|
<p id="ListServiceSets__p1534734153516">Maximum: <strong id="ListServiceSets__b134712411352">36</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row18343154193520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListServiceSets__p034811433511">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListServiceSets__p23487416353">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListServiceSets__p163482433512">Description</p>
|
|
<p id="ListServiceSets__p93491344355">Minimum: <strong id="ListServiceSets__b1734915453510">2</strong></p>
|
|
<p id="ListServiceSets__p134920453514">Maximum: <strong id="ListServiceSets__b834913453514">512</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListServiceSets__section17349549356"><h4 class="sectiontitle">Example Requests</h4><p id="ListServiceSets__p193501948352">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__screen1535044153518">https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/service-sets?object_id=a37bb4eb-c49e-4e88-bf77-944a75b0ce8a&limit=10&offset=0</pre>
|
|
</div>
|
|
<div class="section" id="ListServiceSets__section1235116413354"><h4 class="sectiontitle">Example Responses</h4><p id="ListServiceSets__p135184113510"><strong id="ListServiceSets__b193519463511">Status code: 200</strong></p>
|
|
<p id="ListServiceSets__p0351154123512">Response to the request for querying service group information</p>
|
|
<pre class="screen" id="ListServiceSets__screen113526411357">{
|
|
"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__p535611463510"><strong id="ListServiceSets__b1035704103516">Status code: 400</strong></p>
|
|
<p id="ListServiceSets__p15357134143516">Bad Request</p>
|
|
<pre class="screen" id="ListServiceSets__screen20357344353">{
|
|
"error_code" : "CFW.0020016",
|
|
"error_msg" : "instance status error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ListServiceSets__section065564193510"><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__row173913412358"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListServiceSets__p765520420359">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__p156551245359">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceSets__row16391114173513"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p1665513415358">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p176556473510">Response to the request for querying service group information</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row1439113413518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p186554453516">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p4655349354">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row7391743352"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p116563417356">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p065654153520">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row16391846355"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p365615473511">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p196561545354">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row1139117411351"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p136567413351">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p1565674113510">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceSets__row1939284123515"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSets__p106561646353">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSets__p265616453514">Internal Server Error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListServiceSets__section1265674173519"><h4 class="sectiontitle">Error Codes</h4><p id="ListServiceSets__p156565483510">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 Set Management</a></div>
|
|
</div>
|
|
</div>
|
|
|