vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/elb/api-ref/elb_zq_hz_0003.html

296 lines
32 KiB
HTML
Raw Blame History

<a name="elb_zq_hz_0003"></a><a name="elb_zq_hz_0003"></a>
<h1 class="topictitle1">Querying Details of a Backend Server Group</h1>
<h4 class="sectiontitle">Function</h4><p id="elb_zq_hz_0003__en-us_topic_0096561548_p1687845151413">This API is used to query details about a backend server group using its ID.</p>
<h4 class="sectiontitle">URI</h4><p id="elb_zq_hz_0003__en-us_topic_0096561548_p399189491">GET /v2.0/lbaas/pools/{pool_id}</p>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hz_0003__en-us_topic_0096561548_table122987220314" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="elb_zq_hz_0003__en-us_topic_0096561548_row11338921238"><th align="left" class="cellrowborder" valign="top" width="18.98%" id="mcps1.3.2.3.2.5.1.1"><p id="elb_zq_hz_0003__en-us_topic_0096561548_p143381921233">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.48%" id="mcps1.3.2.3.2.5.1.2"><p id="elb_zq_hz_0003__en-us_topic_0096561548_p93382027317">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.259999999999998%" id="mcps1.3.2.3.2.5.1.3"><p id="elb_zq_hz_0003__en-us_topic_0096561548_p23381221834">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.28%" id="mcps1.3.2.3.2.5.1.4"><p id="elb_zq_hz_0003__en-us_topic_0096561548_p233862336">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hz_0003__en-us_topic_0096561548_row17338221936"><td class="cellrowborder" valign="top" width="18.98%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_p0338121632">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.48%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_p3338326320">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_p14390152311214">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.28%" headers="mcps1.3.2.3.2.5.1.4 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_p63384218319">Specifies the ID of the backend server group.</p>
</td>
</tr>
</tbody>
</table>
<h4 class="sectiontitle">Request</h4><p id="elb_zq_hz_0003__en-us_topic_0096561548_p10593101615144">None</p>
<h4 class="sectiontitle">Response</h4>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0049139648_table16393628" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0049139648_row17403488"><th align="left" class="cellrowborder" valign="top" width="23.169999999999998%" id="mcps1.3.4.2.2.4.1.1"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0049139648_p396418">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.61%" id="mcps1.3.4.2.2.4.1.2"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0049139648_p32109884">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.22%" id="mcps1.3.4.2.2.4.1.3"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0049139648_p18229659">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0049139648_row207374"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.2.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0049139648_p16797371">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.2.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_p839212319212">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.2.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0049139648_p57853219">Specifies the backend server group. For details, see <a href="#elb_zq_hz_0003__en-us_topic_0096561548_table374714321310">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
<a name="elb_zq_hz_0003__en-us_topic_0096561548_table374714321310"></a><a name="en-us_topic_0096561548_table374714321310"></a><table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hz_0003__en-us_topic_0096561548_table374714321310" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b390964712">pools</strong> parameter description</caption><thead align="left"><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row129412056850"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.3.2.4.1.1"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p8941556758">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.3.2.4.1.2"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p5941205616511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66%" id="mcps1.3.4.3.2.4.1.3"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p19941155610513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row1994112561351"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p6941956051">id</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p6395118132915">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p394185614510">Specifies the ID of the backend server group.</p>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row694135617510"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p18941356653">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p6942145615514">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p133818413522">Specifies the ID of the project where the backend server group is used.</p>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p17033816399">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row189421561755"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p99422562513">name</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p169421456857">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p894213562510">Specifies the name of the backend server group.</p>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p11736124214399">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row7942165615511"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p694235612516">description</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p99423564514">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p17942115615520">Provides supplementary information about the backend server group.</p>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p12272194573912">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row6942115618510"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p129428561458">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p209421556751">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p12345548148">Specifies the protocol that the backend server group uses to receive requests.</p>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p205871558161412">TCP, UDP, and HTTP are supported.</p>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p12123121610154">When a backend server group is associated with a listener, the relationships between the protocol used by the listener and the protocol of the backend server group are as follows:</p>
<ul id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_ul162192018201516"><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li182191187158">When the protocol used by the listener is <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b379817447">UDP</strong>, the protocol of the backend server group must be <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b477261583">UDP</strong>.</li><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li18967142001519">When the protocol used by the listener is <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b2097143325">TCP</strong>, the protocol of the backend server group must be <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b1703817181">TCP</strong>.</li><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li587092441512">When the protocol used by the listener is <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b413593817">HTTP</strong> or <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b1707544441">TERMINATED_HTTPS</strong>, the protocol of the backend server group must be <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b560124993">HTTP</strong>.</li></ul>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row694235612512"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p199426561657">lb_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p149431356051">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p1190711287157">Specifies the load balancing algorithm of the backend server group.</p>
The value can be one of the following:<ul id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_ul1064992814235"><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li206513287239"><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b1794111372911">ROUND_ROBIN</strong>: indicates the weighted round robin algorithm.</li><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li965313286237"><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b16960191417295">LEAST_CONNECTIONS</strong>: indicates the weighted least connections algorithm.</li><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li1165702842316"><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b8945715182910">SOURCE_IP</strong>: indicates the source IP hash algorithm. When the value is <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b3577112981412">SOURCE_IP</strong>, the weights of backend servers in the server group are invalid.</li></ul>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row1194465616515"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p14944256556">members</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p12944656151">Array</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p139440561151">Lists the IDs of backend servers in the backend server group.</p>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row159441356956"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p17944155618514">healthmonitor_id</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p10245320142912">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p159441556659">Specifies the ID of the health check configured for the backend server group.</p>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row49441756554"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p1594419562516">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p5944135616511">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p114391647141511">Specifies the administrative status of the backend server group.</p>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p17626191241414">This parameter is reserved. The value can be <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_en-us_topic_0141008273_b165949352520">true</strong> or <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_en-us_topic_0141008273_b76047354513">false</strong>.</p>
<ul id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_ul19626181281410"><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_en-us_topic_0141008273_li1786915015393"><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_en-us_topic_0141008273_b1178053714514">true</strong>: Enabled</li><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_en-us_topic_0141008273_li1031815323916"><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_en-us_topic_0141008273_b1524614510615">false</strong>: Disabled</li></ul>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row0944135615511"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p15944165613512">listeners</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p59448565512">Array</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p12944125619511">Lists the IDs of listeners associated with the backend server group.</p>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row494419564513"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p594495614516">loadbalancers</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p694413561519">Array</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p189451656658">Lists the IDs of load balancers associated with the backend server group.</p>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row209451156154"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p16945185612516">session_persistence</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p109451564513">Object</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p18458175215155">Specifies whether to enable sticky sessions. For details, see <a href="elb_zq_hz_0001.html#elb_zq_hz_0001__en-us_topic_0096561549_table1659974218492">Table 9</a>.</p>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p166781654171513">Once sticky session are enabled, requests from the same client are sent to the same backend server during the session.</p>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p19438135717159">When sticky sessions are disabled, the value is <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b11162048195216">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hz_0003__en-us_topic_0096561548_table17641175071912" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b5199253122014">members</strong> parameter description</caption><thead align="left"><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row17642135018199"><th align="left" class="cellrowborder" valign="top" width="25.290000000000003%" id="mcps1.3.4.4.2.4.1.1"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p564295010190">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.13%" id="mcps1.3.4.4.2.4.1.2"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p126421250191912">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.580000000000005%" id="mcps1.3.4.4.2.4.1.3"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p11642205012199">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row664275021919"><td class="cellrowborder" valign="top" width="25.290000000000003%" headers="mcps1.3.4.4.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p464219506196">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.13%" headers="mcps1.3.4.4.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p156423501195">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.580000000000005%" headers="mcps1.3.4.4.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p164210502197">Specifies the ID of the associated backend server.</p>
</td>
</tr>
</tbody>
</table>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hz_0003__en-us_topic_0096561548_table672914459541" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b138465752014">listeners</strong> parameter description</caption><thead align="left"><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row4729345175415"><th align="left" class="cellrowborder" valign="top" width="25.290000000000003%" id="mcps1.3.4.5.2.4.1.1"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p11729194505417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.13%" id="mcps1.3.4.5.2.4.1.2"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p1272917457543">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.580000000000005%" id="mcps1.3.4.5.2.4.1.3"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p10729345185415">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row7729124519544"><td class="cellrowborder" valign="top" width="25.290000000000003%" headers="mcps1.3.4.5.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p47291451542">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.13%" headers="mcps1.3.4.5.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p172954519544">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.580000000000005%" headers="mcps1.3.4.5.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p97291745165416">Specifies the ID of the associated backend server group.</p>
</td>
</tr>
</tbody>
</table>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hz_0003__en-us_topic_0096561548_table13106184745416" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b1137917127218">loadbalancers</strong> parameter description</caption><thead align="left"><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row101064477540"><th align="left" class="cellrowborder" valign="top" width="25.290000000000003%" id="mcps1.3.4.6.2.4.1.1"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p20106194715549">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.13%" id="mcps1.3.4.6.2.4.1.2"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p9106447115412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.580000000000005%" id="mcps1.3.4.6.2.4.1.3"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p41061147105415">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row1110684720544"><td class="cellrowborder" valign="top" width="25.290000000000003%" headers="mcps1.3.4.6.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p141068470547">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.13%" headers="mcps1.3.4.6.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p1110614745415">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.580000000000005%" headers="mcps1.3.4.6.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p1810694735420">Specifies the ID of the associated load balancer.</p>
</td>
</tr>
</tbody>
</table>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hz_0003__en-us_topic_0096561548_table1925152813472" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b897659784">session_persistence</strong> parameter description</caption><thead align="left"><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row12652114216495"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.7.2.4.1.1"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p8652134218493">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.7.2.4.1.2"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p965284214496">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67%" id="mcps1.3.4.7.2.4.1.3"><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p3652164264914">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row16652114264914"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.7.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p106528426495">type</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.7.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p665216429491">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.7.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p1082720181618">Specifies the sticky session type.</p>
The value can be one of the following:<ul id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_ul258091011289"><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li175822109282"><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b13160219163613">SOURCE_IP</strong>: Requests are distributed based on the client's IP address. Requests from the same IP address are sent to the same backend server.</li><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li1058512100288"><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b13123122818366">HTTP_COOKIE</strong>: When the client sends a request for the first time, the load balancer automatically generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to the backend server that processes the first request.</li><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li1858851072810"><strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b9757628366">APP_COOKIE</strong>: When the client sends a request for the first time, the backend server that receives the request generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to this backend server.</li></ul>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p1382521641612">When the protocol of the backend server group is TCP, only <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b9575159612">SOURCE_IP</strong> takes effect. When the protocol of the backend server group is HTTP, only <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b1758181519614">HTTP_COOKIE</strong> or <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b45814151266">APP_COOKIE</strong> takes effect.</p>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row765217429490"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.7.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p26521442114916">cookie_name</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.7.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p16653174214493">String</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.7.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p1184122312164">Specifies the cookie name.</p>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p8672254169">This parameter is mandatory when the sticky session type is <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b19041396">APP_COOKIE</strong>.</p>
</td>
</tr>
<tr id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_row268634152316"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.7.2.4.1.1 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p1190604118422">persistence_timeout</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.7.2.4.1.2 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p19102413425">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.7.2.4.1.3 "><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p31964815179">Specifies the sticky session timeout duration in minutes.</p>
<p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_p18281115101717">This parameter is invalid when <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b20486547017">type</strong> is set to <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b7485541101">APP_COOKIE</strong>.</p>
<ul id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_ul460616103285"><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li1615191052813">Optional value ranges are as follows:<ul id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_ul19618201052818"><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li18619151018281">When the protocol of the backend server group is TCP or UDP, the value ranges from <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b1218829301">1</strong> to <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b780458296">60</strong>.</li><li id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_li7622510192811">When the protocol of the backend server group is HTTP or HTTPS, the value ranges from <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b452303439">1</strong> to <strong id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561549_b1902239440">1440</strong>.</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
<h4 class="sectiontitle">Example Request</h4><ul id="elb_zq_hz_0003__en-us_topic_0096561548_ul189661410194916"><li id="elb_zq_hz_0003__en-us_topic_0096561548_li1996631018490">Example request: Querying details of a backend server group<pre class="screen" id="elb_zq_hz_0003__en-us_topic_0096561548_screen7510822174913">GET https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332</pre>
</li></ul>
<h4 class="sectiontitle">Example Response</h4><ul id="elb_zq_hz_0003__en-us_topic_0096561548_ul1221487195119"><li id="elb_zq_hz_0003__en-us_topic_0096561548_li142141573512">Example response<pre class="screen" id="elb_zq_hz_0003__en-us_topic_0096561548_screen1821477185115">{
"pool": {
"lb_algorithm": "SOURCE_IP",
"protocol": "TCP",
"description": "",
"admin_state_up": true,
"loadbalancers": [
{
"id": "6f52004c-3fe9-4c09-b8ce-ed9d9c74a3b1"
}
],
"tenant_id": "1867112d054b427e808cc6096d8193a1",
"session_persistence": null,
"healthmonitor_id": null,
"listeners": [
{
"id": "6e29b2cd-4e53-40f6-ae7b-29e918de67f2"
}
],
"members": [],
"id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
"name": "my-pool"
}
}</pre>
</li></ul>
<h4 class="sectiontitle">Status Code</h4><p id="elb_zq_hz_0003__en-us_topic_0096561548_en-us_topic_0096561531_en-us_topic_0049139631_p12358762">For details, see <a href="elb_gc_1102.html#elb_gc_1102">Status Codes</a>.</p>
<strong>Parent topic:</strong> <a href="elb_zq_hz_0000.html">Backend Server Group</a>
View Git Blame Copy Permalink