调用UpdateServerGroupAttribute接口更新服务器组属性-负载均衡-阿里云

更新负载均衡服务器组属性。

接口说明

UpdateServerGroupAttribute 接口属于异步接口，即系统返回一个请求 ID，但该服务器组的配置尚未更新成功，系统后台的更新任务仍在进行。您可以调用 ListServerGroups 查询服务器组的配置的更新状态：

当服务器组的配置处于 Configuring 状态时，表示服务器组的配置正在更新中。
当服务器组的配置处于 Available 状态时，表示服务器组的配置更新成功。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gwlb:UpdateServerGroupAttribute

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ServerGroupId	string	是	服务器组 ID。	sgp-atstuj3rtoptyui****
ServerGroupName	string	否	服务器组名称。长度为 2~128 个字符，必须以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。	testServerGroupName
Scheduler	string	否	调度算法。取值： 5TCH：五元组哈希，基于五元组（源 IP、目的 IP、源端口、目的端口和协议）的一致性哈希，相同的流会调度到相同的后端服务器。 3TCH：三元组哈希，基于三元组（源 IP、目的 IP 和协议）的一致性哈希，相同的流会调度到相同的后端服务器。 2TCH：二元组哈希，基于二元组（源 IP 和目的 IP）的一致性哈希，相同的流会调度到相同的后端服务器。	5TCH
ServerFailoverMode	string	否	服务器异常时，存量流量的处理方式。取值： NoRebalance：不重新平衡现有流量。 Rebalance：重新平衡现有流量。	NoRebalance
ConnectionDrainConfig	object	否	连接优雅中断相关配置。
ConnectionDrainEnabled	boolean	否	是否开启连接优雅中断。取值： true：开启。 false：关闭。	false
ConnectionDrainTimeout	integer	否	连接优雅中断超时时间。单位：秒。取值范围：1~3600。	300
HealthCheckConfig	object	否	健康检查相关配置。
HealthCheckConnectPort	integer	否	健康检查使用的后端服务器的端口。取值范围： 1~65535。	80
HealthCheckConnectTimeout	integer	否	健康检查响应的最大超时时间。单位：秒。取值范围：1~300。	5
HealthCheckDomain	string	否	用于健康检查的域名。取值： $SERVER_IP：使用后端服务器内网 IP。 domain：指定特定域名。长度限制 1~80 个字符，只能使用大小写字母、数字、短划线（-）、半角句号（.）。说明仅 HealthCheckProtocol 为 HTTP 时，该参数生效。	$SERVER_IP
HealthCheckEnabled	boolean	否	是否开启健康检查，取值： true：开启。 false：关闭。	true
HealthCheckHttpCode	array	否	健康状态返回码列表。
	string	否	健康状态返回码，多个状态码用半角逗号（,）分隔。取值： http_2xx：返回 HttpCode 为 2xx 视为健康状态。 http_3xx：返回 HttpCode 为 3xx 视为健康状态。 http_4xx：返回 HttpCode 为 4xx 视为健康状态。 http_5xx：返回 HttpCode 为 5xx 视为健康状态。默认值：http_2xx 。说明仅 HealthCheckProtocol 为 HTTP 时，该参数生效。	http_2xx
HealthCheckInterval	integer	否	健康检查的时间间隔。单位：秒。取值范围：1~50。	10
HealthCheckPath	string	否	健康检查路径。长度为 1~80 个字符，只能使用大小写英文字母、数字、字符`-/.%?#&`。必须以正斜线（/）开头。说明仅 HealthCheckProtocol 为 HTTP 时，该参数生效。	/test/index.html
HealthCheckProtocol	string	否	健康检查协议，取值： TCP：通过发送 SYN 握手报文来检测服务器端口是否存活。 HTTP：通过发送 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。	TCP
HealthyThreshold	integer	否	健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。取值范围：2~10。	2
UnhealthyThreshold	integer	否	健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。取值范围：2~10。	2
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会更新服务器组信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。	false
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-42665544****

返回参数

名称	类型	描述	示例值
	object	返回数据结构体。
RequestId	string	请求 ID。	54B48E3D-DF70-471B-AA93-08E683A1B45

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45\n"
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.HealthCheckProtocol	The param of %s is illegal.	健康检查协议非法，请检查输入参数。
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	资源%s当前状态%s不支持操作
400	OperationDenied.SchedulerNotConfigurable	The scheduling algorithm of server group is configurable only when TCP idle timeout of listener is default value.	TCP连接空闲超时时间为非默认值时，服务器组调度算法仅支持五元组哈希。
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.	指定的服务器组资源不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。