yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
79a69012633620c6999ea9f83e2150ccd5be911e
doc-exports/docs/elb/api-ref/ListPools.html
zhoumeng 79a6901263 ELB_API_20251118_Version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: zhoumeng <zhoumeng35@huawei.com>
Co-committed-by: zhoumeng <zhoumeng35@huawei.com>
2025-12-04 21:11:56 +00:00

873 lines
52 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="ListPools"></a><a name="ListPools"></a>
<h1 class="topictitle1">Querying Backend Server Groups</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query all backend server groups.</p>
</div>
<div class="section"><h4 class="sectiontitle">Constraints</h4><p>This API has the following constraints:</p>
<ul><li><p>Parameters <strong>marker</strong>, <strong>limit</strong>, and <strong>page_reverse</strong> are used for pagination query.</p>
</li><li><p>Parameters <strong>marker</strong> and <strong>page_reverse</strong> take effect only when they are used together with parameter <strong>limit</strong>.</p>
</li></ul>
</div>
<div class="section" id="ListPools__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v3/{project_id}/elb/pools</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the ID of the last record on the previous page.</p>
<p>Note:</p>
<ul><li><p>This parameter must be used together with <strong>limit</strong>.</p>
</li><li><p>If this parameter is not specified, the first page will be queried.</p>
</li><li><p>This parameter cannot be left blank or set to an invalid ID.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the number of records on each page.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>2000</strong></p>
<p>Default: <strong>2000</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>page_reverse</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies whether to use reverse query. Values:</p>
<ul><li><p><strong>true</strong>: Query the previous page.</p>
</li><li><p><strong>false</strong> (default): Query the next page.</p>
</li></ul>
<p>Note:</p>
<ul><li><p>This parameter must be used together with <strong>limit</strong>.</p>
</li><li><p>If <strong>page_reverse</strong> is set to <strong>true</strong> and you want to query the previous page, set the value of <strong>marker</strong> to the value of <strong>previous_marker</strong>.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Provides supplementary information about the backend server group.</p>
<p>Multiple descriptions can be queried in the format of <em>description=xxx&amp;description=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the administrative status of the backend server group.</p>
<p>This parameter is unsupported. Please do not use it.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>healthmonitor_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the ID of the health check configured for the backend server group.</p>
<p>Multiple IDs can be queried in the format of <em>healthmonitor_id=xxx&amp;healthmonitor_id=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the ID of the backend server group.</p>
<p>Multiple IDs can be queried in the format of <em>id=xxx&amp;id=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the backend server group name.</p>
<p>Multiple names can be queried in the format of <em>name=xxx&amp;name=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>loadbalancer_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the ID of the load balancer with which the backend server group is associated.</p>
<p>Multiple IDs can be queried in the format of <em>loadbalancer_id=xxx&amp;loadbalancer_id=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>protocol</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the protocol used by the backend server group to receive requests from the load balancer. The value can be <strong>TCP</strong>, <strong>UDP</strong>, <strong>HTTP</strong>, <strong>HTTPS</strong>, or <strong>QUIC</strong>.</p>
<p>Multiple protocols can be queried in the format of <em>protocol=xxx&amp;protocol=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>lb_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the associated backend server group.</p>
<p>The value can be one of the following:</p>
<ul><li><p><strong>ROUND_ROBIN</strong>: weighted round robin</p>
</li><li><p><strong>LEAST_CONNECTIONS</strong>: weighted least connections</p>
</li><li><p><strong>SOURCE_IP</strong>: source IP hash</p>
</li><li><p><strong>QUIC_CID</strong>: connection ID</p>
</li></ul>
<p>Multiple algorithms can be queried in the format of <em>lb_algorithm=xxx&amp;lb_algorithm=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the enterprise project ID.</p>
<ul><li><p>If this parameter is not passed, resources in the default enterprise project are queried, and authentication is performed based on the default enterprise project.</p>
</li><li><p>If this parameter is passed, its value can be the ID of an existing enterprise project (resources in the specific enterprise project are required) or <strong>all_granted_eps</strong> (resources in all enterprise projects are queried).</p>
</li></ul>
<p>Multiple IDs can be queried in the format of <em>enterprise_project_id=xxx&amp;enterprise_project_id=xxx</em>.</p>
<p>This parameter is unsupported. Please do not use it.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the IP address version supported by the backend server group.</p>
<p>Multiple versions can be queried in the format of <em>ip_version=xxx&amp;ip_version=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>member_address</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the private IP address bound to the backend server. This is a query parameter and will not be included in the response.</p>
<p>Multiple IP addresses can be queried in the format of <em>member_address=xxx&amp;member_address=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>member_device_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the ID of the cloud server that serves as a backend server. This parameter is used only as a query condition and is not included in the response.</p>
<p>Multiple IDs can be queried in the format of <em>member_device_id=xxx&amp;member_device_id=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>member_deletion_protection_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies whether to enable removal protection on backend servers.</p>
<ul><li><p><strong>true</strong>: Enable removal protection.</p>
</li><li><p><strong>false</strong>: Disable removal protection.</p>
</li></ul>
<p>All backend servers will be queried if this parameter is not passed.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>listener_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the IDs of the associated listeners, including the listeners associated through forwarding policies.</p>
<p>Multiple IDs can be queried in the format of <em>listener_id=xxx&amp;listener_id=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>member_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the backend server ID. This parameter is used only as a query condition and is not included in the response.</p>
<p>Multiple IDs can be queried in the format of <em>member_instance_id=xxx&amp;member_instance_id=xxx</em>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the ID of the VPC where the backend server group works.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the type of the backend server group.</p>
<p>Values:</p>
<ul><li><p><strong>instance</strong>: Any type of backend servers can be added. <strong>vpc_id</strong> is mandatory.</p>
</li><li><p><strong>ip</strong>: Only IP as backend servers can be added. <strong>vpc_id</strong> cannot be specified.</p>
</li><li><p><strong>""</strong>: Any type of backend servers can be added.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>protection_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Specifies the protection status.</p>
<p>Value options:</p>
<ul><li><p><strong>nonProtection</strong> (default): The load balancer is not protected.</p>
</li><li><p><strong>consoleProtection</strong>: <strong>Modification Protection</strong> is enabled on the console.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListPools__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p>X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p>Specifies the token used for IAM authentication.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListPools__response_ListPoolsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p>request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p>Specifies the request ID. The value is automatically generated.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p>page_info</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p><a href="#ListPools__response_PageInfo">PageInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p>Shows pagination information.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p>pools</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p>Array of <a href="#ListPools__response_Pool">Pool</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p>Lists the backend server groups.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPools__response_PageInfo"></a><a name="response_PageInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPools__response_PageInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>PageInfo</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>previous_marker</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the ID of the first record in the pagination query result.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>next_marker</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the ID of the last record in the pagination query result.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>current_count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p>Specifies the number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPools__response_Pool"></a><a name="response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPools__response_Pool" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Pool</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the administrative status of the backend server group. The value can only be <strong>true</strong>.</p>
<p>This parameter is unsupported. Please do not use it.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Provides supplementary information about the backend server group.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>healthmonitor_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the ID of the health check configured for the backend server group.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the backend server group ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>lb_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the associated backend server group.</p>
<p>The value can be one of the following:</p>
<ul><li><p><strong>ROUND_ROBIN</strong>: weighted round robin</p>
</li><li><p><strong>LEAST_CONNECTIONS</strong>: weighted least connections</p>
</li><li><p><strong>SOURCE_IP</strong>: source IP hash</p>
</li><li><p><strong>QUIC_CID</strong>: connection ID</p>
</li></ul>
<p>Note:</p>
<ul><li><p>If the value is <strong>SOURCE_IP</strong>, the <strong>weight</strong> parameter will not take effect for backend servers.</p>
</li><li><p><strong>QUIC_CID</strong> is supported only when the protocol of the backend server group is QUIC.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>listeners</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>Array of <a href="#ListPools__response_ListenerRef">ListenerRef</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the IDs of the listeners with which the backend server group is associated.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>loadbalancers</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>Array of <a href="#ListPools__response_LoadBalancerRef">LoadBalancerRef</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the IDs of the load balancers with which the backend server group is associated.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>members</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>Array of <a href="#ListPools__response_MemberRef">MemberRef</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the IDs of the backend servers in the backend server group.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the backend server group name.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the project ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>protocol</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the protocol used by the backend server group to receive requests. The value can be <strong>TCP</strong>, <strong>UDP</strong>, <strong>HTTP</strong>, <strong>HTTPS</strong>, or <strong>QUIC</strong>.</p>
<ul><li><p>If the listener's protocol is <strong>UDP</strong>, the protocol of the backend server group must be <strong>UDP</strong> or <strong>QUIC</strong>.</p>
</li><li><p>If the listener's protocol is <strong>TCP</strong>, the protocol of the backend server group must be <strong>TCP</strong>.</p>
</li><li><p>If the listener's protocol is <strong>HTTP</strong>, the protocol of the backend server group must be <strong>HTTP</strong>.</p>
</li><li><p>If the listener's protocol is <strong>HTTPS</strong>, the protocol of the backend server group can be <strong>HTTP</strong> or <strong>HTTPS</strong>.</p>
</li><li><p>If the listener's protocol is <strong>TERMINATED_HTTPS</strong>, the protocol of the backend server group must be <strong>HTTP</strong>.</p>
</li><li><p>If the backend server group protocol is <strong>QUIC</strong>, sticky session must be enabled with <strong>type</strong> set to <strong>SOURCE_IP</strong>.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>session_persistence</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p><a href="#ListPools__response_SessionPersistence">SessionPersistence</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the sticky session.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the IP address version supported by the backend server group.</p>
<ul><li><p>Shared load balancers: The value is fixed at <strong>v4</strong>.</p>
</li><li><p>Dedicated load balancers: The value can be <strong>dualstack</strong> or <strong>v4</strong>. If the protocol of the backend server group is TCP or UDP, the value is <strong>dualstack</strong>. If the protocol of the backend server group is HTTP or HTTPS, the value is <strong>v4</strong>.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>slow_start</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p><a href="#ListPools__response_SlowStart">SlowStart</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies slow start details. After you enable slow start, new backend servers added to the backend server group are warmed up, and the number of requests they can receive increases linearly during the configured slow start duration.</p>
<p>This parameter can be used when the protocol of the backend server group is HTTP or HTTPS. An error will be returned if the protocol is not HTTP or HTTPS.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>member_deletion_protection_enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies whether to enable removal protection.</p>
<ul><li><p><strong>true</strong>: Enable removal protection.</p>
</li><li><p><strong>false</strong>: Disable removal protection.</p>
</li></ul>
<div class="note"><span class="notetitle"> NOTE: </span><div class="notebody">Disable removal protection for all your resources before deleting your account.</div></div>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the time when a backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).</p>
<p>This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the time when a backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).</p>
<p>This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the ID of the VPC where the backend server group works.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the type of the backend server group.</p>
<p>Values:</p>
<ul><li><p><strong>instance</strong>: Any type of backend servers can be added. <strong>vpc_id</strong> is mandatory.</p>
</li><li><p><strong>ip</strong>: Only IP as backend servers can be added. <strong>vpc_id</strong> cannot be specified.</p>
</li><li><p><strong>""</strong>: Any type of backend servers can be added.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>protection_status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies the protection status.</p>
<p>Value options:</p>
<ul><li><p><strong>nonProtection</strong> (default): The load balancer is not protected.</p>
</li><li><p><strong>consoleProtection</strong>: <strong>Modification Protection</strong> is enabled on the console.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>protection_reason</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies why the modification protection is enabled.</p>
<p>Note: This parameter is valid only when <strong>protection_status</strong> is set to <strong>consoleProtection</strong>. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (&lt;&gt;).</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>255</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>az_affinity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p><a href="#ListPools__response_AzAffinity">AzAffinity</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p>Specifies how AZ affinity is configured for the backend server group.</p>
<p>This parameter is unsupported. Please do not use it.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPools__response_ListenerRef"></a><a name="response_ListenerRef"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPools__response_ListenerRef" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ListenerRef</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p>Specifies the listener ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPools__response_LoadBalancerRef"></a><a name="response_LoadBalancerRef"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPools__response_LoadBalancerRef" frame="border" border="1" rules="all"><caption><b>Table 8 </b>LoadBalancerRef</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.7.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p>id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p>Specifies the load balancer ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPools__response_MemberRef"></a><a name="response_MemberRef"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPools__response_MemberRef" frame="border" border="1" rules="all"><caption><b>Table 9 </b>MemberRef</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.8.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p>id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p>Specifies the backend server ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPools__response_SessionPersistence"></a><a name="response_SessionPersistence"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPools__response_SessionPersistence" frame="border" border="1" rules="all"><caption><b>Table 10 </b>SessionPersistence</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.9.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p>cookie_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p>Specifies the cookie name.</p>
<p>The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).</p>
<p>Note: This parameter will take effect only when <strong>type</strong> is set to <strong>APP_COOKIE</strong>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p>type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p>Specifies the sticky session type. The value can be <strong>SOURCE_IP</strong>, <strong>HTTP_COOKIE</strong>, or <strong>APP_COOKIE</strong>.</p>
<p>Note:</p>
<ul><li><p>If the protocol of the backend server group is <strong>TCP</strong> or <strong>UDP</strong>, only <strong>SOURCE_IP</strong> takes effect.</p>
</li><li><p>For dedicated load balancers, if the protocol of the backend server group is <strong>HTTP</strong> or <strong>HTTPS</strong>, the value can only be <strong>HTTP_COOKIE</strong>.</p>
</li><li><p>If the backend server group protocol is <strong>QUIC</strong>, sticky session must be enabled with <strong>type</strong> set to <strong>SOURCE_IP</strong>.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p>persistence_timeout</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p>Specifies the stickiness duration, in minutes. This parameter will not take effect when <strong>type</strong> is set to <strong>APP_COOKIE</strong>.</p>
<ul><li><p>If the protocol of the backend server group is TCP, UDP, or QUIC, the value ranges from <strong>1</strong> to <strong>60</strong>, and the default value is <strong>1</strong>.</p>
</li><li><p>If the protocol of the backend server group is HTTP or HTTPS, the value ranges from <strong>1</strong> to <strong>1440</strong>, and the default value is <strong>1440</strong>.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPools__response_SlowStart"></a><a name="response_SlowStart"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPools__response_SlowStart" frame="border" border="1" rules="all"><caption><b>Table 11 </b>SlowStart</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.10.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p>enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p>Specifies whether to enable slow start.</p>
<ul><li><p><strong>true</strong>: Enable slow start.</p>
</li><li><p><strong>false</strong>: Disable slow start.</p>
</li></ul>
<p>Default: <strong>false</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p>duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p>Specifies the slow start duration, in seconds.</p>
<p>The value ranges from <strong>30</strong> to <strong>1200</strong>, and the default value is <strong>30</strong>.</p>
<p>Minimum: <strong>30</strong></p>
<p>Maximum: <strong>1200</strong></p>
<p>Default: <strong>30</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPools__response_AzAffinity"></a><a name="response_AzAffinity"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPools__response_AzAffinity" frame="border" border="1" rules="all"><caption><b>Table 12 </b>AzAffinity</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.11.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p>enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p>Specifies whether to enable AZ affinity for the backend server group. If this parameter is set to <strong>true</strong>, ELB forwards traffic across the backend servers in the same AZ as the load balancer.</p>
<p>Constraints:</p>
<ul><li><p>This parameter is available only for TCP and UDP backend server groups.</p>
</li><li><p>This parameter is not available for backend server groups that are associated with TLS listeners.</p>
</li><li><p>If the parameter is set to <strong>true</strong>, parameter <strong>pool_health</strong> will be ignored.</p>
</li></ul>
<p>The value can be <strong>false</strong> (disabled) or <strong>true</strong> (enabled).</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p>az_minimum_healthy_member_percentage</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p>Specifies a percentage that is used to determine the health of an AZ. If the percentage of healthy servers in the AZ of the load balancer falls below the specified value, <strong>az_unhealthy_fallback_strategy</strong> is triggered. <strong>az_minimum_healthy_member_percentage</strong> shows the ratio of healthy servers to total servers in a backend server group of an AZ. The number of healthy servers is rounded up. For example, in AZ A, if there are three backend servers in the backend server group and <strong>az_minimum_healthy_member_percentage</strong> is set to 66%, the number of healthy servers is rounded up to 2 (3 × 0.66 = 1.98). If there are fewer than two healthy servers in AZ A, <strong>az_unhealthy_fallback_strategy</strong> is triggered. If <strong>az_minimum_healthy_member_percentage</strong> is set to 67%, the number of healthy servers is rounded up to 3 (3 × 0.67 = 2.01). If there are fewer than three healthy servers in AZ A, <strong>az_unhealthy_fallback_strategy</strong> is triggered.</p>
<p>Constraints:</p>
<ul><li><p>If <strong>enable</strong> is set to <strong>true</strong>, <strong>az_minimum_healthy_member_percentage</strong> and <strong>az_minimum_healthy_member_count</strong> cannot be set to <strong>-1</strong> at the same time.</p>
</li><li><p>If <strong>enable</strong> is set to <strong>true</strong>, either <strong>az_minimum_healthy_member_percentage</strong> or <strong>az_minimum_healthy_member_count</strong> must be set to <strong>-1</strong>.</p>
</li></ul>
<p>Value range: an integer ranging from <strong>-1</strong> to <strong>100</strong>. <strong>-1</strong> indicates that <strong>az_minimum_healthy_member_count</strong> takes effect.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p>az_minimum_healthy_member_count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p>Specifies a number that is used to determine the health of an AZ. If the number of healthy servers in the AZ of the load balancer falls below the specified value, <strong>az_unhealthy_fallback_strategy</strong> is triggered. <strong>az_minimum_healthy_member_count</strong> shows the number of healthy servers to total servers in a backend server group of an AZ.</p>
<p>Constraints:</p>
<ul><li><p>If <strong>enable</strong> is set to <strong>true</strong>, <strong>az_minimum_healthy_member_percentage</strong> and <strong>az_minimum_healthy_member_count</strong> cannot be set to <strong>-1</strong> at the same time.</p>
</li><li><p>If <strong>enable</strong> is set to <strong>true</strong>, either <strong>az_minimum_healthy_member_percentage</strong> or <strong>az_minimum_healthy_member_count</strong> must be set to <strong>-1</strong>.</p>
</li></ul>
<p>Value range: an integer ranging from <strong>-1</strong> to <strong>10000</strong>. <strong>-1</strong> indicates that <strong>az_minimum_healthy_member_percentage</strong> takes effect.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p>az_unhealthy_fallback_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p>Specifies how traffic will be distributed across backend servers in an AZ if the percentage or number of healthy servers in the AZ of the load balancer falls below the specified value.</p>
<p>Value options:</p>
<ul><li><p><strong>forward_to_all_member_of_local_az</strong>: forwards requests across all backend servers in the same AZ as the load balancer, even if some servers are unhealthy.</p>
</li><li><p><strong>forward_to_healthy_member_of_remote_az</strong>: forwards requests across healthy backend servers in different AZs from the load balancer.</p>
</li><li><p><strong>forward_to_all_healthy_member</strong>: forwards requests across healthy backend servers in all AZs.</p>
</li><li><p><strong>forward_to_all_member</strong>: forwards requests across all backend servers in all AZs, even if some servers are unhealthy.</p>
</li></ul>
<p>The value can be <strong>forward_to_all_member_of_local_az</strong>, <strong>forward_to_healthy_member_of_remote_az</strong>, <strong>forward_to_all_healthy_member</strong>, or <strong>forward_to_all_member</strong>.</p>
<p>Default value: <strong>forward_to_all_member_of_local_az</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools?limit=2</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Successful request.</p>
<pre class="screen">{
"pools" : [ {
"lb_algorithm" : "ROUND_ROBIN",
"protocol" : "HTTP",
"type" : "",
"vpc_id" : "",
"description" : "",
"admin_state_up" : true,
"member_deletion_protection_enable" : false,
"loadbalancers" : [ {
"id" : "309a0f61-0b62-45f2-97d1-742f3434338e"
} ],
"project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
"session_persistence" : {
"cookie_name" : "my_cookie",
"type" : "APP_COOKIE",
"persistence_timeout" : 1
},
"healthmonitor_id" : "",
"listeners" : [ ],
"members" : [ ],
"id" : "73bd4fe0-ffbb-4b56-aab4-4f26ddf7a103",
"name" : "",
"ip_version" : "v4"
}, {
"lb_algorithm" : "SOURCE_IP",
"protocol" : "TCP",
"description" : "",
"admin_state_up" : true,
"member_deletion_protection_enable" : false,
"loadbalancers" : [ {
"id" : "d9763e59-64b7-4e93-aec7-0ff7881ef9bc"
} ],
"project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
"session_persistence" : {
"cookie_name" : "",
"type" : "SOURCE_IP",
"persistence_timeout" : 1
},
"healthmonitor_id" : "",
"listeners" : [ {
"id" : "8d21db6f-b475-429e-a9cb-90439b0413b2"
} ],
"members" : [ ],
"id" : "74db02d1-5711-4c77-b383-a450e2b93142",
"name" : "pool_tcp_001",
"ip_version" : "dualstack"
} ],
"page_info" : {
"next_marker" : "74db02d1-5711-4c77-b383-a450e2b93142",
"previous_marker" : "73bd4fe0-ffbb-4b56-aab4-4f26ddf7a103",
"current_count" : 2
},
"request_id" : "a1a7e852-1928-48f7-bbc9-ca8469898713"
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListPools__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Successful request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="module_pools.html">Backend Server Group</a></div>
</div>
</div>
View Git Blame Copy Permalink