yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
12211d6d9cbd2bfdb18aadc10faed67f3ac77bc2
doc-exports/docs/cfw/api-ref/ListServiceItems.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

436 lines
31 KiB
HTML
Raw Blame History

<a name="ListServiceItems"></a><a name="ListServiceItems"></a>
<h1 class="topictitle1">Querying the Service Group Member List</h1>
<div id="body1708331107508"><div class="section" id="ListServiceItems__section20488735113110"><h4 class="sectiontitle">Function</h4><p id="ListServiceItems__p1548843523117">This API is used to query the service group member list.</p>
</div>
<div class="section" id="ListServiceItems__section748863533111"><h4 class="sectiontitle">URI</h4><p id="ListServiceItems__p1348893563119">GET /v1/{project_id}/service-items</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__table949017357318" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListServiceItems__row6489163583118"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListServiceItems__p184901535173113">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListServiceItems__p134907355315">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListServiceItems__p1049013518315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListServiceItems__p204905355314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row1248903520314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListServiceItems__p184903358315">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListServiceItems__p04911735153117">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListServiceItems__p54918354314">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListServiceItems__p649143513119">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="ListServiceItems__table1649218351316" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListServiceItems__row16491135163118"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListServiceItems__p1349243517316">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListServiceItems__p1349214357311">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListServiceItems__p104931235113116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListServiceItems__p1349312352313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row0491173520319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p3493335123117">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p64932352317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p7493735113110">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p144937350314">Service group ID, which can be obtained by calling the <a href="ListServiceSets.html">API for querying the service group list</a>. Find the value in <strong id="ListServiceItems__b2049311355310">data.records.set_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="ListServiceItems__row3492235183115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p249415354311">key_word</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p154941035193118">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p12494835203112">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p1649493583116">Query field, which can be a service group member name or a part of the service group member description.</p>
</td>
</tr>
<tr id="ListServiceItems__row1549217355313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p1049414356317">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p184941435143118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p12494163520311">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p149543517313">Number of records displayed on each page. The value ranges from 1 to 1024.</p>
</td>
</tr>
<tr id="ListServiceItems__row1649213593116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p2049563511318">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p154953356317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p1495123523120">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p19495635123119">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__b2049563573117">0</strong>.</p>
</td>
</tr>
<tr id="ListServiceItems__row11492335133111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p449513357311">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p64962356317">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p1449617354312">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p17496103563116">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="ListServiceItems__b14496173563111">0</strong>.</p>
</td>
</tr>
<tr id="ListServiceItems__row19492935143110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p849633511317">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceItems__p74963353315">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p949613510317">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p4497535183114">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="ListServiceItems__row17492153583119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceItems__p1349703553110">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__p16497535173116">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceItems__p13497153512312">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceItems__p17497153553119">Type of the service group to be queried: <strong id="ListServiceItems__b11497235173115">0</strong> (user-defined service group), <strong id="ListServiceItems__b149711351312">1</strong> (predefined service group). This parameter is valid only if <strong id="ListServiceItems__b194981335193117">set_id</strong> is the ID of a predefined service group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListServiceItems__section1149883516316"><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__row84981035193111"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListServiceItems__p11498235193117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListServiceItems__p4499735163111">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListServiceItems__p1249933518319">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListServiceItems__p8499135123111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row13498103533116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListServiceItems__p1249983512316">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListServiceItems__p1449914356313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListServiceItems__p13499123514318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListServiceItems__p1449913593119">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="ListServiceItems__row1289555133114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListServiceItems__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListServiceItems__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListServiceItems__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListServiceItems__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListServiceItems__section8500173573115"><h4 class="sectiontitle">Response Parameters</h4><p id="ListServiceItems__p6500335163116"><strong id="ListServiceItems__b0500113515311">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__row150073513115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListServiceItems__p15501103543119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListServiceItems__p135011535143114">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListServiceItems__p35015350315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row9500113503113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListServiceItems__p15501143511310">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListServiceItems__p165011135183115"><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__p950143573120">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__row1250216358318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListServiceItems__p125021835173120">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListServiceItems__p45021350312">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListServiceItems__p14503183515313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row5502143510319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceItems__p19503193573118">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceItems__p14503123518316">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceItems__p1250314356319">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__b1750317356318">0</strong>.</p>
</td>
</tr>
<tr id="ListServiceItems__row11502635183112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceItems__p175039359313">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceItems__p850316359310">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceItems__p1350443593112">Number of records displayed on each page. The value ranges from 1 to 1024.</p>
</td>
</tr>
<tr id="ListServiceItems__row85027356313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceItems__p1450417356311">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceItems__p16504193573117">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceItems__p8504163583118">Total number of service group members.</p>
</td>
</tr>
<tr id="ListServiceItems__row350253513112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceItems__p150414358311">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceItems__p1850443533114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceItems__p950423593113">Service group ID.</p>
</td>
</tr>
<tr id="ListServiceItems__row350220352316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceItems__p55055359319">records</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceItems__p1505133503118">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__p15505143563110">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__row105051735103116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListServiceItems__p1350663563120">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListServiceItems__p9506435143117">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListServiceItems__p1350623593114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row185055356316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p850613514316">item_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p1950733523119">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p1250703543112">Service member ID.</p>
</td>
</tr>
<tr id="ListServiceItems__row1250593511314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p165076353316">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p1850793583119">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p165071535123112">Protocol type: <strong id="ListServiceItems__b10507193510317">6</strong> (TCP), <strong id="ListServiceItems__b1550723563117">17</strong> (UDP), <strong id="ListServiceItems__b1350816353316">1</strong> (ICMP), <strong id="ListServiceItems__b145081635163111">58</strong> (ICMPv6), or <strong id="ListServiceItems__b17508193553117">-1</strong> (any). It cannot be left blank when <strong id="ListServiceItems__b85081735193120">type</strong> is set to <strong id="ListServiceItems__b145081635173111">0</strong> (manual), and can be left blank when <strong id="ListServiceItems__b25081035163110">type</strong> is set to <strong id="ListServiceItems__b2508235193118">1</strong> (automatic).</p>
</td>
</tr>
<tr id="ListServiceItems__row850512355313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p1750819351315">source_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p1250833513317">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p450883533116">Source port.</p>
</td>
</tr>
<tr id="ListServiceItems__row155055352317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p55081635193114">dest_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p10508183520312">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p95081035133117">Destination port.</p>
</td>
</tr>
<tr id="ListServiceItems__row1050612358313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListServiceItems__p6509113515311">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListServiceItems__p75092035113115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListServiceItems__p65091354311">Service member description.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListServiceItems__p20509183515313"><strong id="ListServiceItems__b750953515319">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__row16509133514313"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListServiceItems__p1551083563119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListServiceItems__p1451053511316">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListServiceItems__p4510163511313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row145094351312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListServiceItems__p16510035153117">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListServiceItems__p1251023533117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListServiceItems__p11511143583114">Error code.</p>
</td>
</tr>
<tr id="ListServiceItems__row125097359311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListServiceItems__p12511935123115">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListServiceItems__p8511113573118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListServiceItems__p18511113513113">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListServiceItems__p8511193513317"><strong id="ListServiceItems__b151113503115">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__response_-" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListServiceItems__row5511173519316"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="ListServiceItems__p11512103523117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="ListServiceItems__p7512935143119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="ListServiceItems__p7512153513114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row10511103512314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListServiceItems__p145121935203112">-</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListServiceItems__p11512183519314">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 ">&nbsp;&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<p id="ListServiceItems__p1651363514313"><strong id="ListServiceItems__b5513173513314">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__table4513235163111" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ListServiceItems__row155131735113117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="ListServiceItems__p7513193512319">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="ListServiceItems__p551323516316">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="ListServiceItems__p4514133510311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row7513103563110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ListServiceItems__p10514103511318">-</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ListServiceItems__p251411352317">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 ">&nbsp;&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<p id="ListServiceItems__p751443518315"><strong id="ListServiceItems__b7514163513110">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__table1951413351316" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="ListServiceItems__row951423511318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="ListServiceItems__p751515358315">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="ListServiceItems__p951519351318">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="ListServiceItems__p165151735143116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row11514635113120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ListServiceItems__p4515535153115">-</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ListServiceItems__p14515113553118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 ">&nbsp;&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<p id="ListServiceItems__p1851619358313"><strong id="ListServiceItems__b851683563119">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceItems__table1516173515310" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="ListServiceItems__row1351633543110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.1"><p id="ListServiceItems__p3516235113119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.2"><p id="ListServiceItems__p1451673563116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.15.2.4.1.3"><p id="ListServiceItems__p1251718351318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row16516635173110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="ListServiceItems__p3517135143119">-</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="ListServiceItems__p11517835193118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 ">&nbsp;&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListServiceItems__section1851783533115"><h4 class="sectiontitle">Example Requests</h4><p id="ListServiceItems__p7517435123112">Query the members of service group 7cdebed3-af07-494e-a3c2-b88bb8d58b57 in project 9d80d070b6d44942af73c9c3d38e0429.</p>
<pre class="screen" id="ListServiceItems__screen2051813357313">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?set_id=7cdebed3-af07-494e-a3c2-b88bb8d58b57&amp;limit=10&amp;offset=0</pre>
</div>
<div class="section" id="ListServiceItems__section4518193518311"><h4 class="sectiontitle">Example Responses</h4><p id="ListServiceItems__p65189350318"><strong id="ListServiceItems__b951819352311">Status code: 200</strong></p>
<p id="ListServiceItems__p13518235183116">Return value of the service group member list.</p>
<pre class="screen" id="ListServiceItems__screen151913523116">{
"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__p14520203583114"><strong id="ListServiceItems__b152014354315">Status code: 400</strong></p>
<p id="ListServiceItems__p45201635143117">Bad Request</p>
<pre class="screen" id="ListServiceItems__screen952073593110">{
"error_code" : "CFW.00200005",
"error_msg" : "Object not found."
}</pre>
</div>
<div class="section" id="ListServiceItems__section76468353312"><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__row953210359312"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListServiceItems__p46461235193115">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__p464623543117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceItems__row553253583120"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p564663512316">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p464663573111">Return value of the service group member list.</p>
</td>
</tr>
<tr id="ListServiceItems__row953283517317"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p1664683513119">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p1464713514314">Bad Request</p>
</td>
</tr>
<tr id="ListServiceItems__row135322353311"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p156471835193119">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p1264713510312">Unauthorized</p>
</td>
</tr>
<tr id="ListServiceItems__row55329356319"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p5647113573112">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p146471335193110">Forbidden</p>
</td>
</tr>
<tr id="ListServiceItems__row1253218358313"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p1864743510311">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p1064712354319">Not Found</p>
</td>
</tr>
<tr id="ListServiceItems__row125321135123120"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceItems__p19647193533117">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceItems__p10647133515317">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListServiceItems__section56472035143110"><h4 class="sectiontitle">Error Codes</h4><p id="ListServiceItems__p1864763503116">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