Esta página ainda não está disponível no idioma selecionado. Estamos trabalhando para adicionar mais opções de idiomas. Agradecemos sua compreensão.
Querying Backend Server Groups
Function
This API is used to query all backend server groups.
Constraints
This API has the following constraints:
-
Parameters marker, limit, and page_reverse are used for pagination query.
-
Parameters marker and page_reverse take effect only when they are used together with parameter limit.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/elb/pools
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
marker |
No |
String |
Specifies the ID of the last record on the previous page. Note:
|
limit |
No |
Integer |
Specifies the number of records on each page. Value range: 0–2000 Default value: 2000 |
page_reverse |
No |
Boolean |
Specifies whether to use reverse query. Value options:
Note:
|
description |
No |
Array of strings |
Provides supplementary information about the backend server group. Multiple descriptions can be queried in the format of description=xxx&description=xxx. |
admin_state_up |
No |
Boolean |
Specifies the administrative status of the backend server group. |
healthmonitor_id |
No |
Array of strings |
Specifies the ID of the health check configured for the backend server group. Multiple IDs can be queried in the format of healthmonitor_id=xxx&healthmonitor_id=xxx. |
id |
No |
Array of strings |
Specifies the ID of the backend server group. Multiple IDs can be queried in the format of id=xxx&id=xxx. |
name |
No |
Array of strings |
Specifies the backend server group name. Multiple names can be queried in the format of name=xxx&name=xxx. |
loadbalancer_id |
No |
Array of strings |
Specifies the ID of the load balancer with which the backend server group is associated. Multiple IDs can be queried in the format of loadbalancer_id=xxx&loadbalancer_id=xxx. |
protocol |
No |
Array of strings |
Specifies the protocol used by the backend server group to receive requests from the load balancer. The value can be TCP, UDP, TLS, HTTP, HTTPS, GRPC, or QUIC. Multiple protocols can be queried in the format of protocol=xxx&protocol=xxx. |
lb_algorithm |
No |
Array of strings |
Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the associated backend server group. Value options:
Multiple algorithms can be queried in the format of lb_algorithm=xxx&lb_algorithm=xxx. |
enterprise_project_id |
No |
Array of strings |
Specifies the ID of the enterprise project.
Multiple values can be queried in the format of enterprise_project_id=xxx&enterprise_project_id=xxx. |
ip_version |
No |
Array of strings |
Specifies the IP address version supported by the backend server group. Multiple versions can be queried in the format of ip_version=xxx&ip_version=xxx. |
member_address |
No |
Array of strings |
Specifies the private IP address bound to the backend server. This is a query parameter and will not be included in the response. Multiple IP addresses can be queried in the format of member_address=xxx&member_address=xxx. |
member_device_id |
No |
Array of strings |
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. Multiple IDs can be queried in the format of member_device_id=xxx&member_device_id=xxx. |
member_deletion_protection_enable |
No |
Boolean |
Specifies whether to enable deletion protection. Value options:
|
listener_id |
No |
Array of strings |
Specifies the IDs of the associated listeners, including the listeners associated through forwarding policies. Multiple IDs can be queried in the format of listener_id=xxx&listener_id=xxx. |
member_instance_id |
No |
Array of strings |
Specifies the backend server ID. This parameter is used only as a query condition and is not included in the response. Multiple IDs can be queried in the format of member_instance_id=xxx&member_instance_id=xxx. |
vpc_id |
No |
Array of strings |
Specifies the ID of the VPC where the backend server group works. |
type |
No |
Array of strings |
Specifies the type of the backend server group. Value options:
|
protection_status |
No |
Array of strings |
Specifies the protection status. Value options:
|
connection_drain |
No |
Boolean |
Specifies a connection_drain value for query, in the format of connection_drain=true or connection_drain=false. |
pool_health |
No |
String |
This API is used to query whether pool_health is enabled. If minimum_healthy_member_count is 0, pool_health is disabled. If minimum_healthy_member_count is 1, pool_health is enabled. |
any_port_enable |
No |
Boolean |
Specifies whether to enable Forward to Same Port for a backend server group. If this option is enabled, the listener routes the requests to the backend server over the same port as the frontend port. Value options:
|
public_border_group |
No |
String |
Specifies the public border group. |
quic_cid_len |
No |
Integer |
Specifies the QUIC connection ID that is used to query backend server groups. It is used only as a query condition but not as a response parameter. Multiple values can be queried in the format of quic_cid_len=3&quic_cid_len=5. |
quic_cid_offset |
No |
Integer |
Specifies the QUIC connection ID offset that is used to query backend server groups. It is used only as a query condition but not as a response parameter. Multiple values can be queried in the format of quic_cid_offset=1&quic_cid_offset=3. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the token used for IAM authentication. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. Note: The value is automatically generated. |
page_info |
PageInfo object |
Shows pagination information. |
pools |
Array of Pool objects |
Lists the backend server groups. |
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Specifies the ID of the first record in the pagination query result. When page_reverse is set to true, this parameter is used together to query resources on the previous page. |
next_marker |
String |
Specifies the ID of the last record in the pagination query result. |
current_count |
Integer |
Specifies the number of records. |
Parameter |
Type |
Description |
---|---|---|
admin_state_up |
Boolean |
Specifies the administrative status of the backend server group. |
description |
String |
Provides supplementary information about the backend server group. |
healthmonitor_id |
String |
Specifies the ID of the health check configured for the backend server group. |
id |
String |
Specifies the backend server group ID. |
lb_algorithm |
String |
Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the associated backend server group. Value options:
|
listeners |
Array of ListenerRef objects |
Specifies the IDs of the listeners with which the backend server group is associated. |
loadbalancers |
Array of LoadBalancerRef objects |
Specifies the IDs of the load balancers with which the backend server group is associated. |
members |
Array of MemberRef objects |
Specifies the IDs of the backend servers in the backend server group. |
name |
String |
Specifies the backend server group name. |
project_id |
String |
Specifies the project ID. |
protocol |
String |
Specifies the protocol used by the backend server group to receive requests. The value can be TCP, UDP, TLS, HTTP, HTTPS, GRPC, or QUIC. Note:
Note:
|
session_persistence |
SessionPersistence object |
Specifies the sticky session. |
ip_version |
String |
Specifies the IP address version supported by the backend server group. Value range:
|
slow_start |
SlowStart object |
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. 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. |
member_deletion_protection_enable |
Boolean |
Specifies whether to enable deletion protection. Value options:
Disable deletion protection for all your resources before deleting your account. |
created_at |
String |
Specifies the time when the backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time). 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. |
updated_at |
String |
Specifies the time when the backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time). 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. |
vpc_id |
String |
Specifies the ID of the VPC where the backend server group works. |
type |
String |
Specifies the type of the backend server group. Value options:
|
protection_status |
String |
Specifies the protection status. Value options:
|
protection_reason |
String |
Specifies why the modification protection is enabled. Note: This parameter is valid only when protection_status is set to consoleProtection. The value can contain a maximum of 255 Unicode characters, excluding angle brackets (<>). |
any_port_enable |
Boolean |
Specifies whether to enable any_port_enable for a backend server group. If this option is enabled, the listener routes the requests to the backend server over the same port as the frontend port. If this option is disabled, the listener routes the requests over the port specified by protocol_port. Value options:
Note: This option is available only for TCP, UDP, or QUIC backend server groups. |
connection_drain |
ConnectionDrain object |
Specifies the configurations of deregistration delay. This parameter is only available for TCP, UDP, and QUIC backend server groups and TCP and UDP listeners. This parameter takes effect when:
|
enterprise_project_id |
String |
Specifies the ID of the enterprise project that the IP address group belongs to. |
pool_health |
PoolHealth object |
Specifies the configurations of the pool health feature. |
public_border_group |
String |
Specifies the public border group, for example, center. |
quic_cid_hash_strategy |
QuicCidHashStrategy object |
Specifies multi-path forwarding policy based on destination connection IDs. |
Parameter |
Type |
Description |
---|---|---|
cookie_name |
String |
Specifies the cookie name. Note:
Value ranges:
|
type |
String |
Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE. Note:
|
persistence_timeout |
Integer |
Specifies the stickiness duration, in minutes. This parameter will not take effect when type is set to APP_COOKIE.
|
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Specifies whether to enable slow start.
|
duration |
Integer |
Specifies the slow start duration, in seconds. The value ranges from 30 to 1200, and the default value is 30. |
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Specifies whether to enable connection_drain. Value options:
|
timeout |
Integer |
Specifies the deregistration delay timeout, in seconds. The value ranges from 10 to 4000. |
Parameter |
Type |
Description |
---|---|---|
minimum_healthy_member_count |
Integer |
If the number of healthy backend servers is less than the value specified for this parameter, the backend server group is considered as unhealthy. The value can be 0 (disabled) or 1 (enabled). |
Parameter |
Type |
Description |
---|---|---|
len |
Integer |
Specifies the length of the hash factor in the connection ID, in byte. This parameter is valid only when the load balancing algorithm is QUIC_CID. Value range: 1 to 20 Default value: 3 |
offset |
Integer |
Specifies the start position in the connection ID as the hash factor, in byte. This parameter is valid only when the load balancing algorithm is QUIC_CID. Value range: 0 to 19 Default value: 1 |
Example Requests
Querying backend server groups
GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools?limit=2
Example Responses
Status code: 200
Successful request.
{ "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", "pool_health" : { "minimum_healthy_member_count" : 0 } }, { "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", "pool_health" : { "minimum_healthy_member_count" : 0 } } ], "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" }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class ListPoolsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("<YOUR REGION>")) .build(); ListPoolsRequest request = new ListPoolsRequest(); try { ListPoolsResponse response = client.listPools(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPoolsRequest() response = client.list_pools(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPoolsRequest{} response, err := client.ListPools(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class ListPoolsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("<YOUR REGION>")) .build(); ListPoolsRequest request = new ListPoolsRequest(); try { ListPoolsResponse response = client.listPools(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPoolsRequest() response = client.list_pools(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPoolsRequest{} response, err := client.ListPools(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Successful request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot