doc-exports/docs/cfw/api-ref/ListServiceSetDetail.html
2024-05-31 16:33:09 +08:00

270 lines
20 KiB
HTML

<a name="ListServiceSetDetail"></a><a name="ListServiceSetDetail"></a>
<h1 class="topictitle1">Querying Service Set Details</h1>
<div id="body376953143512"><div class="section" id="ListServiceSetDetail__section1576903173513"><h4 class="sectiontitle">Function</h4><p id="ListServiceSetDetail__p1076914313517">This API is used to query the details about a service group.</p>
</div>
<div class="section" id="ListServiceSetDetail__section1777133153519"><h4 class="sectiontitle">URI</h4><p id="ListServiceSetDetail__p107711318351">GET /v1/{project_id}/service-sets/{set_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSetDetail__table1177373103516" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListServiceSetDetail__row1477233123518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListServiceSetDetail__p207731638351">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListServiceSetDetail__p157731438356">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListServiceSetDetail__p107741730356">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListServiceSetDetail__p19774837358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSetDetail__row17772143173513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListServiceSetDetail__p1977414373513">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListServiceSetDetail__p677593103512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListServiceSetDetail__p137750312351">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListServiceSetDetail__p47765313353">Project ID</p>
</td>
</tr>
<tr id="ListServiceSetDetail__row187721231358"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListServiceSetDetail__p47764318354">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListServiceSetDetail__p1777720311357">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListServiceSetDetail__p107771333518">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListServiceSetDetail__p1777193153515">Service group ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSetDetail__table27795353519" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListServiceSetDetail__row97785323517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListServiceSetDetail__p117795383517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListServiceSetDetail__p377911319359">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListServiceSetDetail__p15779137358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListServiceSetDetail__p4780333355">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSetDetail__row7778537352"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSetDetail__p20780193163516">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSetDetail__p1778017323514">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSetDetail__p1578113123512">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSetDetail__p1178113318359">Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.</p>
</td>
</tr>
<tr id="ListServiceSetDetail__row577813315354"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSetDetail__p078112373517">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSetDetail__p178213313352">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSetDetail__p8783132351">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSetDetail__p1778312311357">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="ListServiceSetDetail__row1377817314357"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListServiceSetDetail__p878373193515">query_service_set_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListServiceSetDetail__p8784193133518">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListServiceSetDetail__p17841832352">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListServiceSetDetail__p27842333512">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="ListServiceSetDetail__section47856310354"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSetDetail__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListServiceSetDetail__row10785331351"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListServiceSetDetail__p1787430357">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListServiceSetDetail__p16788134351">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListServiceSetDetail__p207884323520">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListServiceSetDetail__p1478843133512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSetDetail__row47851033354"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListServiceSetDetail__p57891031358">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListServiceSetDetail__p157891633351">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListServiceSetDetail__p147909323513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListServiceSetDetail__p9790332353">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="ListServiceSetDetail__section19790173133510"><h4 class="sectiontitle">Response Parameters</h4><p id="ListServiceSetDetail__p0791203153512"><strong id="ListServiceSetDetail__b8791183123512">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSetDetail__response_ServiceSetDetailResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListServiceSetDetail__row11791173173514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListServiceSetDetail__p1792103203517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListServiceSetDetail__p2079223143519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListServiceSetDetail__p9793833351">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSetDetail__row179112313514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListServiceSetDetail__p137938317350">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListServiceSetDetail__p5794539354"><a href="#ListServiceSetDetail__response_ServiceSetDetailResponseDto">ServiceSetDetailResponseDto</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListServiceSetDetail__p1579411316351">service set detail response</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListServiceSetDetail__response_ServiceSetDetailResponseDto"></a><a name="response_ServiceSetDetailResponseDto"></a><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSetDetail__response_ServiceSetDetailResponseDto" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ServiceSetDetailResponseDto</caption><thead align="left"><tr id="ListServiceSetDetail__row117956363517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListServiceSetDetail__p37965383519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListServiceSetDetail__p27963317354">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListServiceSetDetail__p279714311354">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSetDetail__row479573133516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSetDetail__p1279723133510">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSetDetail__p13798183143514">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSetDetail__p17987310356">Service group ID</p>
</td>
</tr>
<tr id="ListServiceSetDetail__row479517315352"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSetDetail__p679815319358">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSetDetail__p157992315355">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSetDetail__p1680010373513">Service group name</p>
<p id="ListServiceSetDetail__p58011731351">Minimum: <strong id="ListServiceSetDetail__b7801193133514">1</strong></p>
<p id="ListServiceSetDetail__p10801173123510">Maximum: <strong id="ListServiceSetDetail__b17802173143517">255</strong></p>
</td>
</tr>
<tr id="ListServiceSetDetail__row479510312357"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSetDetail__p78021033354">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSetDetail__p158056319350">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSetDetail__p118052315353">Service group description</p>
<p id="ListServiceSetDetail__p9806183143511">Minimum: <strong id="ListServiceSetDetail__b380616393518">1</strong></p>
<p id="ListServiceSetDetail__p680619315350">Maximum: <strong id="ListServiceSetDetail__b1480618318355">255</strong></p>
</td>
</tr>
<tr id="ListServiceSetDetail__row57952315355"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListServiceSetDetail__p7806334358">service_set_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListServiceSetDetail__p1980718363510">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListServiceSetDetail__p880753173510">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>
</tbody>
</table>
</div>
<p id="ListServiceSetDetail__p38089333513"><strong id="ListServiceSetDetail__b1280883193518">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSetDetail__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ListServiceSetDetail__row148094383511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListServiceSetDetail__p78100383512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListServiceSetDetail__p17810173193515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListServiceSetDetail__p2811731356">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSetDetail__row168098383515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListServiceSetDetail__p9811183183520">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListServiceSetDetail__p1681116315351">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListServiceSetDetail__p1181211363517">Error code</p>
<p id="ListServiceSetDetail__p1381243113515">Minimum: <strong id="ListServiceSetDetail__b481215318358">8</strong></p>
<p id="ListServiceSetDetail__p58121316350">Maximum: <strong id="ListServiceSetDetail__b48132343514">36</strong></p>
</td>
</tr>
<tr id="ListServiceSetDetail__row98092316359"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListServiceSetDetail__p1813838354">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListServiceSetDetail__p381493193515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListServiceSetDetail__p11814193123520">Description</p>
<p id="ListServiceSetDetail__p1481513383519">Minimum: <strong id="ListServiceSetDetail__b178151434357">2</strong></p>
<p id="ListServiceSetDetail__p3815153133512">Maximum: <strong id="ListServiceSetDetail__b981613373517">512</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListServiceSetDetail__section1481617313352"><h4 class="sectiontitle">Example Requests</h4><p id="ListServiceSetDetail__p9817238357">Query details about the service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group ID is 221cfdca-3abf-4c30-ab0d-516a03c70866.</p>
<pre class="screen" id="ListServiceSetDetail__screen68171033356">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866</pre>
</div>
<div class="section" id="ListServiceSetDetail__section681833143510"><h4 class="sectiontitle">Example Responses</h4><p id="ListServiceSetDetail__p581973163517"><strong id="ListServiceSetDetail__b581919383515">Status code: 200</strong></p>
<p id="ListServiceSetDetail__p148195323517">Response to the request for querying details about a service group member</p>
<pre class="screen" id="ListServiceSetDetail__screen18820143143511">{
"data" : {
"service_set_type" : 0,
"id" : "221cfdca-3abf-4c30-ab0d-516a03c70866",
"name" : "ceshi2"
}
}</pre>
<p id="ListServiceSetDetail__p18231133351"><strong id="ListServiceSetDetail__b382318319353">Status code: 400</strong></p>
<p id="ListServiceSetDetail__p6823232352">Bad Request</p>
<pre class="screen" id="ListServiceSetDetail__screen208241035356">{
"error_code" : "CFW.00200005",
"error_msg" : "operation content does not exist"
}</pre>
</div>
<div class="section" id="ListServiceSetDetail__section1658916473516"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListServiceSetDetail__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListServiceSetDetail__row78760310359"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListServiceSetDetail__p85896463517">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListServiceSetDetail__p658915420351">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListServiceSetDetail__row10876936350"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSetDetail__p145891742352">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSetDetail__p16589154193519">Response to the request for querying details about a service group member</p>
</td>
</tr>
<tr id="ListServiceSetDetail__row887616303511"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSetDetail__p1858918410357">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSetDetail__p8589134183518">Bad Request</p>
</td>
</tr>
<tr id="ListServiceSetDetail__row2087613312352"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSetDetail__p25892417355">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSetDetail__p12589543351">Unauthorized</p>
</td>
</tr>
<tr id="ListServiceSetDetail__row9876103103513"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSetDetail__p15894417354">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSetDetail__p25901749352">Forbidden</p>
</td>
</tr>
<tr id="ListServiceSetDetail__row118766363515"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSetDetail__p8590134193511">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSetDetail__p55901240351">Not Found</p>
</td>
</tr>
<tr id="ListServiceSetDetail__row787663133516"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListServiceSetDetail__p145901433515">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListServiceSetDetail__p125909418356">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListServiceSetDetail__section2590144153518"><h4 class="sectiontitle">Error Codes</h4><p id="ListServiceSetDetail__p165904417353">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>