文档首页> 弹性负载均衡 ELB> API参考> API（V3）> 后端服务器组> 更新后端服务器组

更新时间：2024-06-07 GMT+08:00

在线调试

CLI示例

查看PDF

更新后端服务器组

功能介绍

更新后端服务器组。

接口约束

如果与pool绑定的load balancer的provisioning status不是ACTIVE，则不能更新该pool。

调用方法

请参见如何调用API。

URI

PUT /v3/{project_id}/elb/pools/{pool_id}

表1 路径参数
参数	是否必选	参数类型	描述
pool_id	是	String	后端服务器组ID。
project_id	是	String	项目ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	IAM鉴权Token。

表3 请求Body参数
参数	是否必选	参数类型	描述
pool	是	UpdatePoolOption object	后端服务器组对象。

表4 UpdatePoolOption
参数	是否必选	参数类型	描述
admin_state_up	否	Boolean	后端云服务器组的管理状态，只支持更新为true。
description	否	String	后端云服务器组的描述信息。最小长度：0 最大长度：255
lb_algorithm	否	String	后端云服务器组的负载均衡算法。取值： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。 QUIC_CID：连接ID算法。使用说明：当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。只有pool的protocol为QUIC时，才支持QUIC_CID算法。
name	否	String	后端云服务器组的名称。最小长度：0 最大长度：255
session_persistence	否	UpdatePoolSessionPersistenceOption object	会话持久性对象。
slow_start	否	UpdatePoolSlowStartOption object	慢启动信息。开启慢启动后，将会在设定的时间段（duration）内对新添加到后端服务器组的后端服务器进行预热，转发到该服务器的请求数量线性增加。当后端服务器组的协议为HTTP/HTTPS时有效，其他协议传入该字段将报错。
member_deletion_protection_enable	否	Boolean	是否开启删除保护。取值：false不开启，true开启。说明：退场时需要先关闭所有资源的删除保护开关。
vpc_id	否	String	后端云服务器组关联的虚拟私有云的ID。只有vpc_id为空时允许更新。最小长度：0 最大长度：36
type	否	String	后端服务器组的类型。取值： instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。 ip：只能添加跨VPC后端，type指定为该类型时，vpc_id不允许指定。空字符串（""）：允许任意类型的后端使用说明：只有type为空时允许更新，不允许从非空更新为空。
protection_status	否	String	修改保护状态, 取值： nonProtection: 不保护 consoleProtection: 控制台修改保护
protection_reason	否	String	设置保护的原因说明：仅当protection_status为consoleProtection时有效。最小长度：0 最大长度：255
any_port_enable	否	Boolean	后端是否开启端口透传。开启后，后端服务器端口与前端监听器端口保持一致。关闭后，请求会转发给后端服务器protocol_port字段指定端口。取值：false不开启，true开启。使用说明：仅QUIC,TCP,UDP的pool支持。
pool_health	否	PoolHealth object	后端全下线转发配置

表5 UpdatePoolSessionPersistenceOption
参数	是否必选	参数类型	描述
cookie_name	否	String	cookie名称。共享型LB，支持字母、数字、中划线(-)和下划线()，最大长度64个字符。独享型LB，支持字母、数字、中划线(-)、下划线()和点号(.)，最大长度255个字符。使用说明：只有当type为APP_COOKIE时才有效。其他情况下传该字段会报错。
type	否	String	会话保持类型。取值范围：SOURCE_IP、HTTP_COOKIE、APP_COOKIE。使用说明：当pool的protocol为TCP、UDP，无论type取值如何，都会被忽略，会话保持只按SOURCE_IP生效。当pool的protocol为HTTP、HTTPS时。type可以为HTTP_COOKIE和APP_COOKIE，其他取值会话保持失效。若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。
persistence_timeout	否	Integer	会话保持的时间。当type为APP_COOKIE时不生效。适用范围：如果pool的protocol为TCP、UDP和QUIC则范围为[1,60]（分钟），默认值1；如果pool的protocol为HTTP和HTTPS则范围为[1,1440]（分钟），默认值1440。

表6 UpdatePoolSlowStartOption
参数	是否必选	参数类型	描述
enable	否	Boolean	慢启动的开关，默认值：false； true：开启； false：关闭
duration	否	Integer	慢启动的持续时间，单位：s。默认：30；取值范围：30~1200 最小值：30 最大值：1200

表7 PoolHealth
参数	是否必选	参数类型	描述
minimum_healthy_member_count	否	Integer	当健康检查在线的member个数小于该个数，判定pool的state为不健康；取值范围：0或者1； 0：默认值，不生效； 1：全下线转发生效；

响应参数

状态码： 200

表8 响应Body参数
参数	参数类型	描述
request_id	String	请求ID。注：自动生成。
pool	Pool object	后端服务器组对象。

表9 Pool
参数	参数类型	描述
admin_state_up	Boolean	后端云服务器组的管理状态。
description	String	后端云服务器组的描述信息。
healthmonitor_id	String	后端云服务器组关联的健康检查的ID。
id	String	后端云服务器组的ID。
lb_algorithm	String	后端云服务器组的负载均衡算法。取值： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。 QUIC_CID：连接ID算法。使用说明：当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。只有pool的protocol为QUIC时，才支持QUIC_CID算法。
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、HTTP、HTTPS、QUIC、GRPC和TLS。使用说明： listener的protocol为UDP时，pool的protocol必须为UDP或QUIC。 listener的protocol为TCP时pool的protocol必须为TCP。 listener的protocol为HTTP时，pool的protocol必须为HTTP。 listener的protocol为HTTPS时，pool的protocol必须为HTTP、HTTPS或GRPC。 listener的protocol为TERMINATED_HTTPS时，pool的protocol必须为HTTP。 listener的protocol为QUIC时，pool的protocol必须为HTTP、HTTPS或GRPC。 listener的protocol为TLS时，pool的protocol必须为TLS或TCP。若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。若pool的protocol为GRPC，关联监听器必须开启HTTP2。若pool的protocol为TCP,则pool的ip_version字段取值必须是4。
session_persistence	SessionPersistence object	会话持久性对象。
ip_version	String	后端云服务器组支持的IP版本。取值：共享型：固定为v4；独享型：取值dualstack、v4、v6。当协议为TCP/UDP时，ip_version为dualstack，表示双栈。当协议为HTTP时，ip_version为v4。
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	后端服务器组的类型。取值： instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。 ip：只能添加跨VPC后端，type指定为该类型时，vpc_id不允许指定。空字符串（""）：允许任意类型的后端
protection_status	String	修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护
protection_reason	String	设置保护的原因说明：仅当protection_status为consoleProtection时有效。最小长度：0 最大长度：255
any_port_enable	Boolean	后端是否开启端口透传。开启后，后端服务器端口与前端监听器端口保持一致。关闭后，请求会转发给后端服务器protocol_port字段指定端口。取值：false不开启，true开启。使用说明：仅QUIC,TCP,UDP的pool支持。
connection_drain	ConnectionDrain object	后端服务器的延迟注销的功能配置（只针对TCP、UDP、QUIC协议类型的后端服务器组和TCP、UDP协议类的监听器）以下场景会触发：服务器从后端服务器组中移除后端云服务健康检查状态异常后端云服务器权重修改为0
enterprise_project_id	String	IP地址组所在的企业项目ID。
pool_health	PoolHealth object	后端全下线转发配置

**表10** ListenerRef
参数	参数类型	描述
id	String	监听器ID。

**表11** LoadBalancerRef
参数	参数类型	描述
id	String	负载均衡器ID。

**表12** MemberRef
参数	参数类型	描述
id	String	后端服务器ID。

**表13** SessionPersistence
参数	参数类型	描述
cookie_name	String	cookie名称。共享型LB，支持字母、数字、中划线(-)和下划线()，最大长度64个字符。独享型LB，支持字母、数字、中划线(-)、下划线()和点号(.)，最大长度255个字符。使用说明：只有当type为APP_COOKIE时才有效。其他情况下传该字段会报错。
type	String	会话保持类型。取值范围：SOURCE_IP、HTTP_COOKIE、APP_COOKIE。使用说明：当pool的protocol为TCP、UDP，无论type取值如何，都会被忽略，会话保持只按SOURCE_IP生效。当pool的protocol为HTTP、HTTPS时。如果是独享型负载均衡器的pool，则type只能为HTTP_COOKIE，其他取值会话保持失效。如果是共享型负载均衡器的pool，则type可以为HTTP_COOKIE和APP_COOKIE，其他取值会话保持失效。若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。
persistence_timeout	Integer	会话保持的时间。当type为APP_COOKIE时不生效。适用范围：如果pool的protocol为TCP、UDP和QUIC则范围为[1,60]（分钟），默认值1；如果pool的protocol为HTTP和HTTPS则范围为[1,1440]（分钟），默认值1440。

**表14** SlowStart
参数	参数类型	描述
enable	Boolean	慢启动的开关，默认值：false； true：开启； false：关闭缺省值：false
duration	Integer	慢启动的持续时间。取值：30~1200s，默认30s；最小值：30 最大值：1200 缺省值：30

**表15** ConnectionDrain
参数	参数类型	描述
enable	Boolean	延迟注销功能开关。取值：true 开启，false 关闭，默认true。
timeout	Integer	延迟注销时间，单位：s；取值范围：10~4000

**表16** PoolHealth
参数	参数类型	描述
minimum_healthy_member_count	Integer	当健康检查在线的member个数小于该个数，判定pool的state为不健康；取值范围：0或者1； 0：默认值，不生效； 1：全下线转发生效；

请求示例

更新后端服务组的负载均衡算法

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"
}

状态码

状态码	描述
200	操作正常返回。

错误码

请参见错误码。

父主题：后端服务器组

上一篇：查询后端服务器组详情

下一篇：删除后端服务器组

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

更新后端服务器组

功能介绍

接口约束

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线