负载均衡
负载均衡
应用型负载均衡ALB
请输入
- 文档首页
负载均衡API 参考服务器组ModifyServerGroupAttributes - 修改指定服务器组详细信息
复制全文
下载 pdfModifyServerGroupAttributes - 修改指定服务器组详细信息
文档反馈
问问助手调用 ModifyServerGroupAttributes 接口，修改指定服务器组信息。
使用说明
每秒最多提交 5 个 API 请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：ModifyServerGroupAttributes
要执行的操作，取值：ModifyServerGroupAttributes。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
StickySessionConfig.CookieTimeout integer 可选 示例值：1000
会话保持 Cookie 超时时间。仅在开启会话保持功能并选择植入 Cookie 时有效。 单位：秒。具体规则如下：
- 超时时间的取值范围：1～86400。 默认值为：1000。
- 当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionType 为 insert 时，此参数必填。
- 当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionType 为 server 时，此参数无效。
StickySessionConfig.Cookie string 可选 示例值：MY_COOKIE
服务配置的会话保持 Cookie 名称。仅在开启会话保持功能并选择重写 Cookie 时有效。 具体规则如下：
- Cookie 名称长度为1~200个字符。
- 名称只能包含 ASCII 英文字母和数字字符，不能包含半角逗号（,）、半角分号（;）或空格，也不能以美元符号（$）开头。
- 当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 server时，此参数必填。
- 当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，该参数无效。
StickySessionConfig.StickySessionType string 可选 示例值：insert
对 Cookie 的处理方式。当 StickySessionConfig.StickySessionEnabled 值为 on 时，此字段参数必填。取值如下：
- insert：植入 Cookie；
- ALB 会记录客户端请求第一次转发到的后端服务器。ALB 在返回请求中植入 Cookie ，后续客户端请求携带此 Cookie，ALB 会将请求转发到之前记录的后端服务器上。
- server：重写 Cookie；
- 开启重写 Cookie 的会话保持后，在客户端请求第一次转发到后端服务器后，ALB 在返回请求中发现您自定义的 Cookie 时，会对原来的 Cookie 进行重写。后续客户端请求携带改写后的 Cookie，ALB 会将请求转发到之前记录的后端服务器上。
StickySessionConfig.StickySessionEnabled string 可选 示例值：off
是否开启会话保持。取值如下：
- on：开启。
- off：关闭。
HealthCheck.UnhealthyThreshold integer 可选 示例值：3
健康检查的不健康阈值。
- 表示连续执行指定次数的健康检查，结果均为异常的后端服务器将判定为健康检查异常。
- 单位：次，取值：2~10，默认值为 3。
HealthCheck.HealthyThreshold integer 可选 示例值：3
健康检查的健康阈值。
- 表示连续执行指定次数的健康检查，结果均为正常的后端服务器将判定为健康检查正常。
- 单位：次，取值：2~10，默认值为 3。
HealthCheck.Timeout integer 可选 示例值：2
健康检查的响应超时时间。
- 表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。
- 单位：秒，取值：1~60，默认值为 2。
HealthCheck.Method string 可选 示例值：HEAD
健康检查的方法。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。取值如下：
- GET：服务器需支持GET方法。
- HEAD：服务器仅返回HEAD头部信息，可以降低后端性能消耗，服务器需要支持HEAD方法。
HealthCheck.Domain string 可选 示例值：www.test.com
健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。
HealthCheck.URI string 可选 示例值：health
健康检查的路径，需配置为后端服务器上真实对外提供的路径。默认值为 "/"。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。
HealthCheck.HttpCode string 可选 示例值：http_2xx,http_3xx
健康检查正常的HTTP状态码，多个状态码间用半角逗号","分隔。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。取值如下：
- http_2xx。
- http_3xx。
- http_4xx 。
- http_5xx 。
HealthCheck.HttpVersion string 可选 示例值：HTTP1.0
健康检查HTTP协议版本，只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。取值如下：
- HTTP1.0（使用API时，HTTP协议版本默认值）。
- HTTP1.1。
HealthCheck.Protocol string 可选 示例值：HTTP
健康检查协议。
- HTTP
- TCP
Description string 可选 示例值：This is the default servergroup
后端服务器组的描述。
- 不能以 http:// 或 https:// 开头。
- 必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
- 长度限制为1 ～ 255个字符。
HealthCheck.Interval integer 可选 示例值：2
执行健康检查的时间间隔。 单位：秒，取值：1~300s，默认值为 2。
HealthCheck.Enabled string 可选 示例值：on
监听器是否开启健康检查功能。取值如下：
- on：开启。
- off：不开启。
Scheduler string 可选 示例值：wrr
调度算法。取值如下：
- wrr：加权轮询。
- wlc：加权最小连接数。
- sh：源地址哈希。
ServerGroupName string 可选 示例值：default_servergroup
后端服务器组的名称。
- 必须以字母或中文开头，可包含数字、点号（.）、下划线（_）和短横线（-）。
- 限制为1 ～ 128个字符。
- 不传入该参数或该参数不传入数值时，默认为后端服务器组ID。
HealthCheck.Port integer 可选 示例值：80
健康检查端口。取值如下：
- 0：使用后端服务器端口进行健康检查。
- 1-65535：使用您指定的端口进行健康检查。
CrossZoneEnabled string 可选 示例值：on
是否开启服务器组的跨可用区负载均衡功能。
- 取值如下：
- on：开启。
- off：不开启。
- 如果您不开启该功能，服务器组只能关联标准版 ALB 实例。
SlowStartConfig.SlowStartEnabled string 可选 示例值：off
是否开启慢启动功能。取值如下：
- on：开启。开启后，新加入的健康后端服务器在设定时间内权重从 0 逐步上升到设定值，实现平滑预热。约束如下：
- 仅当调度算法为wrr（加权轮询）时，支持开启慢启动。
- 仅组内已有健康后端服务器时，新加入的健康服务器才会进入慢启动。
- off：不开启。
说明
慢启动功能正在邀测中，如需试用，请联系客户经理。
SlowStartConfig.SlowStartDuration integer 可选 示例值：30
慢启动持续时间。 单位：秒。取值范围：30~900。
ServerGroupId string 必选 示例值：rsp-bp1o94dp5i6ea****
后端服务器组ID。
返回参数
RequestId string 示例值：20210811152539010225146063030****
请求ID。
请求示例
返回示例
错误码
最近更新时间：2026.05.19 08:35:35
这个页面对您有帮助吗？
有用
有用
无用
无用