更新后端服务器组
功能介绍
更新后端服务器组。
接口约束
如果与pool绑定的load balancer的provisioning status不是ACTIVE,则不能更新该pool。
调用方法
请参见如何调用API。
URI
PUT /v3/{project_id}/elb/pools/{pool_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pool_id |
是 |
String |
参数解释:后端服务器组ID。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
project_id |
是 |
String |
参数解释:项目ID。获取方式请参见获取项目ID。 约束限制:不涉及 取值范围:长度为32个字符,由小写字母和数字组成。 默认取值:不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:IAM鉴权Token。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pool |
是 |
UpdatePoolOption object |
参数解释:更新后端服务器组请求参数。 约束限制:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
admin_state_up |
否 |
Boolean |
参数解释:后端服务器组的管理状态。 约束限制:只支持更新为true。 取值范围:true 启用。 默认取值:不涉及 |
description |
否 |
String |
参数解释:后端服务器组的描述信息。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
lb_algorithm |
否 |
String |
参数解释:后端服务器组的负载均衡算法。 约束限制:
取值范围:
默认取值:不涉及 |
name |
否 |
String |
参数解释:后端服务器组的名称。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
session_persistence |
否 |
参数解释:会话持久性对象。 约束限制:慢启动与会话保持不能同时开启。若都开启则会导致会话保持失效。 |
|
slow_start |
否 |
UpdatePoolSlowStartOption object |
参数解释:慢启动信息。开启慢启动后,将会在设定的时间段(duration)内对新添加到后端服务器组的后端服务器进行预热,转发到该服务器的请求数量线性增加。 约束限制:
|
member_deletion_protection_enable |
否 |
Boolean |
参数解释:是否开启后端服务器移除保护。开关开启后,不允许从该ELB后端服务器组下移除后端服务器。 约束限制:
取值范围:false 不开启,true 开启。 默认取值:false
说明:
退场时需要先关闭所有资源的删除保护开关。
|
vpc_id |
否 |
String |
参数解释:后端服务器组关联的虚拟私有云的ID。 约束限制:只有vpc_id为空时允许更新。 取值范围:不涉及 默认取值:不涉及 |
type |
否 |
String |
参数解释:后端服务器组的类型。 约束限制:
取值范围:不涉及 默认取值:不涉及 |
protection_status |
否 |
String |
参数解释:修改保护状态。 约束限制:不涉及 取值范围:
默认取值:不涉及 |
protection_reason |
否 |
String |
参数解释:设置保护的原因。作为protection_status的转态设置的原因。 约束限制:仅当protection_status为consoleProtection时有效。 取值范围:除'<'和'>'外通用Unicode字符集字符,最大255个字符。 默认取值:不涉及 |
any_port_enable |
否 |
Boolean |
参数解释:后端是否开启全端口转发。开启后,后端服务器端口与前端监听器端口保持一致。关闭后,请求会转发给后端服务器protocol_port字段指定端口。 约束限制:仅QUIC,TCP,UDP的pool支持。 取值范围:false 不开启,true 开启。 默认取值:false |
connection_drain |
否 |
ConnectionDrain object |
参数解释:后端服务器的延迟注销的功能配置。 以下场景会触发:
约束限制:只针对TCP、UDP、QUIC协议类型的后端服务器组和TCP、UDP协议类的监听器。 |
pool_health |
否 |
PoolHealth object |
参数解释:后端全下线转发配置。 约束限制: 不涉及 |
quic_cid_hash_strategy |
否 |
QuicCidHashStrategy object |
参数解释:后端服务器组基于部分DST CID的多径分发策略配置。 约束限制:不涉及 |
az_affinity |
否 |
UpdateAzAffinity object |
参数解释:后端服务器组的可用区亲和策略配置。 约束限制:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cookie_name |
否 |
String |
参数解释:cookie名称。 约束限制:
取值范围:最大长度1024个字符。 默认取值:不涉及 |
type |
否 |
String |
参数解释:会话保持类型。 约束限制:
取值范围:SOURCE_IP、HTTP_COOKIE、APP_COOKIE。 默认取值:不涉及 |
persistence_timeout |
否 |
Integer |
参数解释:会话保持的时间。 约束限制:当type为APP_COOKIE时不生效。 取值范围:
默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enable |
否 |
Boolean |
参数解释:慢启动的开关。 约束限制:不涉及 取值范围:true 开启,false 关闭。 默认取值:不涉及 |
duration |
否 |
Integer |
参数解释:慢启动的持续时间。 约束限制:不涉及 取值范围:30~1200,单位:秒。 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enable |
否 |
Boolean |
参数解释:延迟注销功能开关。 约束限制:不涉及 取值范围:true 开启,false 关闭。 默认取值:不涉及 |
timeout |
否 |
Integer |
参数解释:延迟注销时间。 约束限制:不涉及 取值范围:10~4000,单位:秒。 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
minimum_healthy_member_count |
否 |
Integer |
参数解释:当健康检查在线的member个数小于该个数,判定pool的state为不健康。 取值范围:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
len |
是 |
Integer |
参数解释:表示hash的时候取CID的长度。 约束限制:仅当负载均衡算法为QUIC_CID的时候才生效。 取值范围:1-20 默认取值:3 |
offset |
是 |
Integer |
参数解释:表示hash的时候取CID的偏移量。 约束限制:仅当负载均衡算法为QUIC_CID的时候才生效。 取值范围:0-19 默认取值:1 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enable |
否 |
Boolean |
参数解释:后端服务器组可用区亲和开关。 约束限制:
取值范围:true或false,true表示开启,false表示关闭。 默认取值:不涉及 |
az_minimum_healthy_member_percentage |
否 |
Integer |
参数解释:后端服务器组单可用区百分比健康度最小阈值,当“后端服务器组单可用区百分比健康度”小于该阈值时,触发可用区异常退避策略。“后端服务器组单可用区百分比健康度”是指在一个后端服务器组中,同可用区中健康检查结果正常的服务器数量与该后端服务器组中属于该可用区的后端服务器总数量的比值,百分比结果向上取整。例如:后端服务器组中属于可用区A的后端服务器总数量为3,设置后端服务器组单可用区百分比健康度最小阈值为66时,3x0.66=1.98向上取整为数量阈值2台,即属于可用区A的健康后端数小于2台时触发退避策略;设置后端服务器组单可用区百分比健康度最小阈值为67时,3x0.67=2.01向上取整为数量阈值3台,即属于可用区A的健康后端数小于3台时触发退避策略。 约束限制:
取值范围:-1至100的整数,0-100为百分比范围,-1表示采用数量阈值。 默认取值:不涉及 |
az_minimum_healthy_member_count |
否 |
Integer |
参数解释:后端服务器组单可用区中数量健康度最小阈值,当“后端服务器组单可用区中数量健康度”小于该阈值时,触发可用区异常退避策略。“后端服务器组单可用区中数量健康度”是指在一个后端服务器组中,属于同一个可用区的健康检查结果正常的服务器数量。 约束限制:
取值范围:-1至10000的整数,0-10000为数量范围,-1表示采用百分比阈值。 默认取值:不涉及 |
az_unhealthy_fallback_strategy |
否 |
String |
参数解释:后端服务器组单可用区异常退避策略。后端服务器组的健康度小于所配置的最小阈值时,触发该退避策略。forward_to_all_member_of_local_az:转发至同可用区的所有后端服务器,无论健康检查结果是否正常;forward_to_healthy_member_of_remote_az:转发至非同可用区中所有健康检查结果正常的后端服务器;forward_to_all_healthy_member:转发至所有可用区中健康检查结果正常的后端服务器;forward_to_all_member:转发至所有可用区中的所有后端服务器,无论健康检查结果是否正常 约束限制:不涉及 取值范围:forward_to_all_member_of_local_az,forward_to_healthy_member_of_remote_az,forward_to_all_healthy_member,forward_to_all_member。 默认取值:forward_to_all_member_of_local_az |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
参数解释:请求ID。 取值范围:由数字、小写字母和中划线(-)组成的字符串,自动生成。 |
pool |
Pool object |
参数解释:后端服务器组对象。 |
参数 |
参数类型 |
描述 |
---|---|---|
admin_state_up |
Boolean |
参数解释:后端服务器组的管理状态。只支持设置为true。 取值范围:true 启用。 |
az_affinity |
AzAffinity object |
参数解释:后端服务器组的可用区亲和策略配置。 |
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)内对新添加到后端服务器组的后端服务器进行预热,转发到该服务器的请求数量线性增加。 |
member_deletion_protection_enable |
Boolean |
参数解释:是否开启后端服务器移除保护。开关开启后,不允许从该ELB后端服务器组下移除后端服务器。 取值范围: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 |
参数解释:修改保护状态,。 取值范围:
|
protection_reason |
String |
参数解释:设置保护的原因。作为protection_status的转态设置的原因。 取值范围:除'<'和'>'外通用Unicode字符集字符,最大255个字符。 |
any_port_enable |
Boolean |
参数解释:后端是否开启全端口转发。开启后,后端服务器端口与前端监听器端口保持一致。关闭后,请求会转发给后端服务器protocol_port字段指定端口。取值:false 不开启,true 开启。 约束限制:
|
connection_drain |
ConnectionDrain object |
参数解释:后端服务器的延迟注销的功能配置。 以下场景会触发:
|
enterprise_project_id |
String |
参数解释:资源所属的企业项目ID。 取值范围:
|
pool_health |
PoolHealth object |
参数解释:后端全下线转发配置。 |
public_border_group |
String |
参数解释:公网边界组。 取值范围:
|
quic_cid_hash_strategy |
QuicCidHashStrategy object |
参数解释:后端服务器组基于部分DST CID的多径分发策略配置。 |
参数 |
参数类型 |
描述 |
---|---|---|
enable |
Boolean |
参数解释:后端服务器组是否开启可用区亲和。开启后,负载均衡器会按照配置的亲和策略进行转发。 约束限制:
取值范围:false 不开启,true 开启。 默认取值:不涉及 |
az_minimum_healthy_member_percentage |
Integer |
参数解释:后端服务器组单可用区百分比健康度最小阈值,当“后端服务器组单可用区百分比健康度”小于该阈值时,触发可用区异常退避策略。“后端服务器组单可用区百分比健康度”是指在一个后端服务器组中,同可用区中健康检查结果正常的服务器数量与该后端服务器组中属于该可用区的后端服务器总数量的比值,百分比结果向上取整。例如:后端服务器组中属于可用区A的后端服务器总数量为3,设置后端服务器组单可用区百分比健康度最小阈值为66时,3x0.66=1.98向上取整为数量阈值2台,即属于可用区A的健康后端数小于2台时触发退避策略;设置后端服务器组单可用区百分比健康度最小阈值为67时,3x0.67=2.01向上取整为数量阈值3台,即属于可用区A的健康后端数小于3台时触发退避策略。 约束限制:
取值范围:-1至100的整数,0-100为百分比范围,-1表示采用数量阈值。 默认取值:不涉及 |
az_minimum_healthy_member_count |
Integer |
参数解释:后端服务器组单可用区中数量健康度最小阈值,当“后端服务器组单可用区中数量健康度”小于该阈值时,触发可用区异常退避策略。“后端服务器组单可用区中数量健康度”是指在一个后端服务器组中,属于同一个可用区的健康检查结果正常的服务器数量。 约束限制:
取值范围:-1至10000的整数,0-10000为数量范围,-1表示采用百分比阈值。 默认取值:不涉及 |
az_unhealthy_fallback_strategy |
String |
参数解释:后端服务器组单可用区异常退避策略。后端服务器组的健康度小于所配置的最小阈值时,触发该退避策略。forward_to_all_member_of_local_az:转发至同可用区的所有后端服务器,无论健康检查结果是否正常;forward_to_healthy_member_of_remote_az:转发至非同可用区中所有健康检查结果正常的后端服务器;forward_to_all_healthy_member:转发至所有可用区中健康检查结果正常的后端服务器;forward_to_all_member:转发至所有可用区中的所有后端服务器,无论健康检查结果是否正常 约束限制:不涉及 取值范围:forward_to_all_member_of_local_az,forward_to_healthy_member_of_remote_az,forward_to_all_healthy_member,forward_to_all_member。 默认取值:forward_to_all_member_of_local_az |
参数 |
参数类型 |
描述 |
---|---|---|
cookie_name |
String |
参数解释:cookie名称。 取值范围:最大长度1024个字符。 |
type |
String |
参数解释:会话保持类型。 取值范围:SOURCE_IP、HTTP_COOKIE、APP_COOKIE。 |
persistence_timeout |
Integer |
参数解释:会话保持的时间。当type为APP_COOKIE时不生效。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
enable |
Boolean |
参数解释:慢启动的开关。 取值范围:
|
duration |
Integer |
参数解释:慢启动的持续时间。 取值范围:30-1200,单位:秒。 |
参数 |
参数类型 |
描述 |
---|---|---|
enable |
Boolean |
参数解释:延迟注销功能开关。 约束限制:不涉及 取值范围:true 开启,false 关闭。 默认取值:不涉及 |
timeout |
Integer |
参数解释:延迟注销时间。 约束限制:不涉及 取值范围:10~4000,单位:秒。 默认取值:不涉及 |
请求示例
更新后端服务组的负载均衡算法
PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75 { "pool" : { "name" : "My pool.", "description" : "My pool update", "lb_algorithm" : "LEAST_CONNECTIONS" } }
响应示例
状态码:200
操作正常返回。
{ "pool" : { "type" : "", "vpc_id" : "", "lb_algorithm" : "LEAST_CONNECTIONS", "protocol" : "TCP", "description" : "My pool update", "admin_state_up" : true, "member_deletion_protection_enable" : false, "loadbalancers" : [ { "id" : "098b2f68-af1c-41a9-8efd-69958722af62" } ], "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "session_persistence" : null, "healthmonitor_id" : null, "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" : "8f40128b-c72b-4b64-986a-f7e2c633d75f" }
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 49 50 51 52 53 54 55 |
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 UpdatePoolSolution { 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(); UpdatePoolRequest request = new UpdatePoolRequest(); request.withPoolId("{pool_id}"); UpdatePoolRequestBody body = new UpdatePoolRequestBody(); UpdatePoolOption poolbody = new UpdatePoolOption(); poolbody.withDescription("My pool update") .withLbAlgorithm("LEAST_CONNECTIONS") .withName("My pool."); body.withPool(poolbody); request.withBody(body); try { UpdatePoolResponse response = client.updatePool(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 33 34 35 36 37 38 39 40 |
# 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 = UpdatePoolRequest() request.pool_id = "{pool_id}" poolbody = UpdatePoolOption( description="My pool update", lb_algorithm="LEAST_CONNECTIONS", name="My pool." ) request.body = UpdatePoolRequestBody( pool=poolbody ) response = client.update_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 39 40 41 42 43 44 45 46 47 48 49 |
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.UpdatePoolRequest{} request.PoolId = "{pool_id}" descriptionPool:= "My pool update" lbAlgorithmPool:= "LEAST_CONNECTIONS" namePool:= "My pool." poolbody := &model.UpdatePoolOption{ Description: &descriptionPool, LbAlgorithm: &lbAlgorithmPool, Name: &namePool, } request.Body = &model.UpdatePoolRequestBody{ Pool: poolbody, } response, err := client.UpdatePool(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。