UpdateServerGroupServersAttribute - 更新后端服务器配置 - 负载均衡

更新网络型负载均衡服务器组中后端服务器的权重和描述信息。

接口说明

UpdateServerGroupServersAttribute 接口属于异步接口，即系统返回一个请求 ID，但该后端服务器配置信息尚未添加成功，系统后台的添加任务仍在进行。

您可以调用 ListServerGroups 查询服务器组状态：
- 当服务器组处于 Configuring 状态时，表示服务器组正在变配中。
- 当服务器组处于 Available 状态时，表示服务器组运行中。
您可以调用 ListServerGroupServers 查询后端服务器状态：
- 当后端服务器处于 Configuring 状态时，表示后端服务器正在变配中。
- 当后端服务器处于 Available 状态时，表示后端服务器运行中。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
nlb:UpdateServerGroupServersAttribute	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
ServerGroupId	string	是	服务器组 ID。	sgp-atstuj3rtoptyui****
Servers	object []	是	后端服务器列表，单次调用最多支持传入 200 个后端服务器。
ServerId	string	是	后端服务器 ID。当服务器组为 Instance 类型时，该参数为 Ecs、Eni、Eci 的资源 ID。当服务器组为 Ip 类型时，该参数为 IP 地址。	i-bp67acfmxazb4p****
ServerType	string	是	后端服务器类型，取值： Ecs：ECS 实例。 Eni：ENI 弹性网卡实例。 Eci：ECI 弹性容器。 Ip：IP 地址。	Ecs
ServerIp	string	否	服务器 IP 地址。当服务器组为 Ip 类型时，必须指定 IP 地址。	192.168.6.6
Port	integer	是	后端服务器使用的端口。取值范围：1~65535。说明该参数暂不支持修改。	443
Weight	integer	否	后端服务器的权重，取值范围：0~100。默认值为 100。如果设置权重为 0，则不会将请求转发给该后端服务器。	100
Description	string	否	服务器描述信息。长度限制为 2-256 个字符，可包含英文字母、数字、中文、半角逗号（,）、半角句号（.）、半角分号（;）、正斜线（/）、at（@）、下划线（_）和短划线（-）。	后端服务器描述
RegionId	string	否	网络型负载均衡实例所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会更新服务器配置信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。	false
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-426655440000

返回参数

名称	类型	描述	示例值
	object	更新后端服务器配置。
RequestId	string	请求 ID。	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	服务器组 ID。	sgp-atstuj3rtoptyui****
JobId	string	异步任务 ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

错误码

HTTP status code	错误码	错误信息	描述
400	IncorrectStatus.serverGroup	The status of servergroup [%s] is incorrect.	服务器组的状态无法进行当前操作，请检查服务器组当前是否处于其他操作下。
400	Conflict.Lock	The Lock [%s] is conflict.	指定的资源当前存在锁冲突。
400	IllegalParam.%s	The param of %s is illegal.	参数%s非法
400	MissingParam.%s	The parameter of %s is missing.	参数%s缺失，请检查输入参数。
403	Forbidden.%s	Authentication is failed for %s.	当前资源或者操作%s鉴权失败
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	因为账号没有权限，所以鉴权失败。
404	ResourceNotFound.BackendServer	The specified resource of BackendServer is not found.	找不到指定的后端服务器资源，请检查输入的参数。
404	ResourceNotFound.serverGroup	The specified resource of serverGroup is not found.	找不到指定的服务器组资源，请检查输入参数。

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

变更历史

变更时间

变更内容概要

操作

2024-01-22

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 403 变更
	删除错误码：400
	删除错误码：404

2023-09-26

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 400 变更
	错误码 404 变更
	删除错误码：403

2023-09-05

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 400 变更
	错误码 404 变更
	删除错误码：403

2023-08-22

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：403
	删除错误码：404

2023-08-22

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	新增错误码：400
	新增错误码：403
	新增错误码：404