查询后端服务器组详情
功能介绍
后端服务器组详情。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/elb/pools/{pool_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目ID。 |
pool_id |
是 |
String |
参数解释:后端服务器组ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:IAM鉴权Token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求ID。 注:自动生成 。 |
pool |
Pool object |
后端服务器组对象。 |
参数 |
参数类型 |
描述 |
---|---|---|
admin_state_up |
Boolean |
参数解释:后端服务器组的管理状态。 |
description |
String |
参数解释:后端服务器组的描述信息。 |
healthmonitor_id |
String |
参数解释:后端服务器组关联的健康检查的ID。 |
id |
String |
参数解释:后端服务器组的ID。 |
lb_algorithm |
String |
参数解释:后端服务器组的负载均衡算法。 约束限制:
取值范围:
|
listeners |
Array of ListenerRef objects |
参数解释:后端服务器组关联的监听器ID列表。 |
loadbalancers |
Array of LoadBalancerRef objects |
参数解释:后端服务器组关联的负载均衡器ID列表。 |
members |
Array of MemberRef objects |
参数解释:后端服务器组中的后端服务器ID列表。 |
name |
String |
参数解释:后端服务器组的名称。 |
project_id |
String |
参数解释:后端服务器组所在的项目ID。 |
protocol |
String |
参数解释:后端服务器组的后端协议。 约束限制:
取值范围:TCP、UDP、TLS、GRPC、HTTP、HTTPS和QUIC。 |
session_persistence |
SessionPersistence object |
参数解释:会话持久性对象。 |
ip_version |
String |
参数解释:后端服务器组支持的IP版本。 取值范围:
|
slow_start |
SlowStart object |
参数解释:慢启动信息。开启慢启动后,将会在设定的时间段(duration)内对新添加到后端服务器组的后端服务器进行预热,转发到该服务器的请求数量线性增加。 约束限制:当后端服务器组的协议为HTTP/HTTPS时有效,其他协议传入该字段将报错。 |
member_deletion_protection_enable |
Boolean |
参数解释:是否开启误删保护。 取值范围:false不开启,true开启。
说明:
退场时需要先关闭所有资源的删除保护开关。 |
created_at |
String |
参数解释:创建时间。 取值范围:格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
updated_at |
String |
参数解释:更新时间。 取值范围:格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
vpc_id |
String |
参数解释:后端服务器组关联的虚拟私有云的ID。 |
type |
String |
参数解释:后端服务器组的类型。 取值范围:
|
protection_status |
String |
参数解释:修改保护状态,。 取值范围:
默认取值:nonProtection |
protection_reason |
String |
参数解释:设置保护的原因。 参数限制:仅当protection_status为consoleProtection时有效。 |
any_port_enable |
Boolean |
参数解释:后端是否开启端口透传。开启后,后端服务器端口与前端监听器端口保持一致。关闭后,请求会转发给后端服务器protocol_port字段指定端口。取值:false不开启,true开启。 约束限制:
|
connection_drain |
ConnectionDrain object |
参数解释:后端服务器的延迟注销的功能配置(只针对TCP、UDP、QUIC协议类型的后端服务器组和TCP、UDP协议类的监听器) 以下场景会触发:
|
enterprise_project_id |
String |
参数解释:IP地址组所在的企业项目ID。 |
pool_health |
PoolHealth object |
参数解释:后端全下线转发配置。 |
public_border_group |
String |
参数解释:可用区组,如:center |
参数 |
参数类型 |
描述 |
---|---|---|
cookie_name |
String |
参数解释:cookie名称。 约束限制:
取值范围:
|
type |
String |
参数解释:会话保持类型。 约束限制:
取值范围:SOURCE_IP、HTTP_COOKIE、APP_COOKIE。 |
persistence_timeout |
Integer |
参数解释:会话保持的时间。当type为APP_COOKIE时不生效。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
enable |
Boolean |
参数解释:慢启动的开关。 取值范围:
默认取值:false |
duration |
Integer |
参数解释:慢启动的持续时间。 取值范围:30-1200,单位:秒。 默认取值:30 |
请求示例
查询后端服务器组详情
GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75
响应示例
状态码: 200
操作正常返回。
{ "pool" : { "type" : "", "vpc_id" : "", "lb_algorithm" : "LEAST_CONNECTIONS", "protocol" : "TCP", "description" : "My pool", "admin_state_up" : true, "member_deletion_protection_enable" : false, "loadbalancers" : [ { "id" : "098b2f68-af1c-41a9-8efd-69958722af62" } ], "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "session_persistence" : null, "healthmonitor_id" : "", "listeners" : [ { "id" : "0b11747a-b139-492f-9692-2df0b1c87193" }, { "id" : "61942790-2367-482a-8b0e-93840ea2a1c6" }, { "id" : "fd8f954c-f0f8-4d39-bb1d-41637cd6b1be" } ], "members" : [ ], "id" : "36ce7086-a496-4666-9064-5ba0e6840c75", "name" : "My pool.", "ip_version" : "dualstack", "pool_health" : { "minimum_healthy_member_count" : 0 } }, "request_id" : "c1a60da2-1ec7-4a1c-b4cc-73e1a57b368e" }
SDK代码示例
SDK代码示例如下。
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 48 |
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 ShowPoolSolution { 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(); ShowPoolRequest request = new ShowPoolRequest(); request.withPoolId("{pool_id}"); try { ShowPoolResponse response = client.showPool(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 32 |
# 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 = ShowPoolRequest() request.pool_id = "{pool_id}" response = client.show_pool(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 38 |
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.ShowPoolRequest{} request.PoolId = "{pool_id}" response, err := client.ShowPool(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。