forked from docs/doc-exports
362 lines
25 KiB
HTML
362 lines
25 KiB
HTML
<a name="ListServiceItems"></a><a name="ListServiceItems"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Service Set Member List</h1>
|
|
<div id="body1736735421"><div class="section" id="ListServiceItems__section8361136425"><h4 class="sectiontitle">Function</h4><p id="ListServiceItems__p163718314429">This API is used to query service group members.</p>
|
|
</div>
|
|
<div class="section" id="ListServiceItems__section23913134215"><h4 class="sectiontitle">URI</h4><p id="ListServiceItems__p24014317422">GET /v1/{project_id}/service-items</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__table164217324219" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListServiceItems__row34153124216"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListServiceItems__p1443535422">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListServiceItems__p11440324216">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListServiceItems__p174415364218">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListServiceItems__p845153124218">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceItems__row2411735426"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListServiceItems__p74612311426">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListServiceItems__p147183134213">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListServiceItems__p10481138429">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListServiceItems__p194833144218">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__table85116318421" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListServiceItems__row194910304215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListServiceItems__p1511832423">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListServiceItems__p45211320421">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListServiceItems__p18531436422">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListServiceItems__p205416324212">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceItems__row11491314218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p185517317420">set_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p16558304211">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p65613124218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p10577374220">Service group ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row14501636429"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p195819312428">key_word</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p2599319424">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p15912324212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p86083174217">Query field</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row125017311427"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p8612344218">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p66117318429">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p14625374213">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p13631317425">Number of records displayed on each page, in the range 1-1024</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row13502394211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p5641438421">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p26414374211">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p19651139423">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p9662312427">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="ListServiceItems__b9662324210">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row185073144216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p16675384216">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p06711316428">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p2068193194215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p146917313422">Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row185019316429"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p670193154212">fw_instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p271123134218">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p10721735422">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p472337422">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="ListServiceItems__row195012310420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p9731431420">query_service_set_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p6741319429">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p97516324217">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p14761835423">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="ListServiceItems__section7777324220"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListServiceItems__row478233420"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListServiceItems__p2799318421">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListServiceItems__p12801334421">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListServiceItems__p0814318429">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListServiceItems__p58212317424">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceItems__row13785314428"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListServiceItems__p08310311421">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListServiceItems__p168313164213">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListServiceItems__p1184836422">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListServiceItems__p685173104213">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="ListServiceItems__section9861738425"><h4 class="sectiontitle">Response Parameters</h4><p id="ListServiceItems__p108715316421"><strong id="ListServiceItems__b168712310424">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__response_ServiceItemListResponseDto" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListServiceItems__row188820354215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListServiceItems__p489137426">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListServiceItems__p14907374218">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListServiceItems__p15915354214">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceItems__row1488173114214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListServiceItems__p129120319427">data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListServiceItems__p1592035421"><a href="#ListServiceItems__response_data">data</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListServiceItems__p119311317420">Service group member list</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListServiceItems__response_data"></a><a name="response_data"></a><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__response_data" frame="border" border="1" rules="all"><caption><b>Table 5 </b>data</caption><thead align="left"><tr id="ListServiceItems__row189414311427"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListServiceItems__p4951037428">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListServiceItems__p6100163134215">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListServiceItems__p81011637423">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceItems__row1941434428"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceItems__p1910243154213">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceItems__p13102123174211">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceItems__p51031533420">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="ListServiceItems__b11103173124216">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row139473184214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceItems__p51049374210">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceItems__p15105123184211">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceItems__p1110543184214">Number of records displayed on each page, in the range 1-1024</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row199415319421"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceItems__p1910618364216">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceItems__p910712317422">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceItems__p1410712312422">Total number of records</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row0946394211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceItems__p1510863104216">set_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceItems__p5109103194218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceItems__p12110637428">service set id</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row39414314218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceItems__p11106394217">records</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceItems__p11111314427">Array of <a href="#ListServiceItems__response_records">records</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceItems__p1611214374217">Record</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListServiceItems__response_records"></a><a name="response_records"></a><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__response_records" frame="border" border="1" rules="all"><caption><b>Table 6 </b>records</caption><thead align="left"><tr id="ListServiceItems__row91131738422"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListServiceItems__p81141314427">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListServiceItems__p3115636421">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListServiceItems__p19116163164210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceItems__row91131838424"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p1211711344213">item_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p1111843174219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p1911919354217">Service member ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row211373144216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p1311919320427">protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p6120434429">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p121211031427">Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row1111383154215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p16122234423">source_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p81221939423">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p71233311420">Source port</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row51131136425"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p161241834424">dest_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p1812410344210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p17125333428">Destination port</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row31138324219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p71263374210">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p51265311425">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p1912718314425">Service member name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row711323114214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p412815317429">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p161281033428">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p312915312424">Service member description</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ListServiceItems__p913018318426"><strong id="ListServiceItems__b1913073144216">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListServiceItems__row61301239422"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListServiceItems__p16133939428">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListServiceItems__p11134123104217">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListServiceItems__p181354324210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceItems__row91311732427"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListServiceItems__p1136193204214">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListServiceItems__p71373334217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListServiceItems__p141383313420">Error code</p>
|
|
<p id="ListServiceItems__p1213883194210">Minimum: <strong id="ListServiceItems__b1013914313429">8</strong></p>
|
|
<p id="ListServiceItems__p161391317422">Maximum: <strong id="ListServiceItems__b14140113194212">36</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row1513183154214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListServiceItems__p14140173144213">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListServiceItems__p171412384220">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListServiceItems__p514216354211">Description</p>
|
|
<p id="ListServiceItems__p17142731427">Minimum: <strong id="ListServiceItems__b71431314426">2</strong></p>
|
|
<p id="ListServiceItems__p214363184212">Maximum: <strong id="ListServiceItems__b111442317421">512</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListServiceItems__section1144173154218"><h4 class="sectiontitle">Example Requests</h4><p id="ListServiceItems__p1614510394215">Query the member list of the service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group ID is 7cdebed3-af07-494e-a3c2-b88bb8d58b57.</p>
|
|
<pre class="screen" id="ListServiceItems__screen14146538429">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?set_id=7cdebed3-af07-494e-a3c2-b88bb8d58b57&limit=10&offset=0</pre>
|
|
</div>
|
|
<div class="section" id="ListServiceItems__section31481334215"><h4 class="sectiontitle">Example Responses</h4><p id="ListServiceItems__p614916318424"><strong id="ListServiceItems__b114993144211">Status code: 200</strong></p>
|
|
<p id="ListServiceItems__p111501838424">Return value of the service group member list</p>
|
|
<pre class="screen" id="ListServiceItems__screen515214313420">{
|
|
"data" : {
|
|
"limit" : 10,
|
|
"offset" : 0,
|
|
"records" : [ {
|
|
"dest_port" : "0",
|
|
"item_id" : "805b711d-c558-41e3-aab1-a4b8c3f1f90b",
|
|
"description" : "",
|
|
"protocol" : 1,
|
|
"source_port" : "0"
|
|
} ],
|
|
"set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57",
|
|
"total" : 1
|
|
}
|
|
}</pre>
|
|
<p id="ListServiceItems__p41616394214"><strong id="ListServiceItems__b01622304219">Status code: 400</strong></p>
|
|
<p id="ListServiceItems__p151621344216">Bad Request</p>
|
|
<pre class="screen" id="ListServiceItems__screen91632034422">{
|
|
"error_code" : "CFW.00200005",
|
|
"error_msg" : "operation content does not exist"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ListServiceItems__section163781535423"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListServiceItems__row42362031429"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListServiceItems__p037823104210">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListServiceItems__p1437818312425">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListServiceItems__row3236931428"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p133794354211">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p83791316429">Return value of the service group member list</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row112362038423"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p1337916314427">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p33806318426">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row1823610384212"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p1538012334214">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p1338053144215">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row82361037428"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p2038093184213">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p12381113134218">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row12361334427"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p338115319425">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p1838116344216">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListServiceItems__row1223612384214"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p12382153164217">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p1238216324214">Internal Server Error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListServiceItems__section43821939425"><h4 class="sectiontitle">Error Codes</h4><p id="ListServiceItems__p43836318420">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>
|
|
|