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

使用说明

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

1. 您可以调用ListServerGroups查询服务器组状态：

  • 当服务器组处于Configuring状态时，表示服务器组正在变配中。
  • 当服务器组处于Available状态时，表示服务器组运行中。

2. 您可以调用ListServerGroupServers查询后端服务器状态：

  • 当后端服务器处于Configuring状态时，表示后端服务器正在变配中。
  • 当后端服务器处于Available状态时，表示后端服务器运行中。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 UpdateServerGroupServersAttribute

系统规定参数。取值：UpdateServerGroupServersAttribute。
ServerGroupId String 是 sgp-atstuj3rtoptyui****

服务器组ID。
Servers.N.ServerId String 是 ecs-bp67acfmxazb4p****

后端服务器ID。单次调用最多支持传入40个后端服务器。

  • 当服务器组为Instance类型时，该参数为Ecs、Eni、Eci的资源ID。
  • 当服务器组为Ip类型时，该参数为IP地址。
Servers.N.ServerType String 是 Ecs

后端服务器类型，取值：

  • Ecs：ECS实例。
  • Eni：ENI弹性网卡实例。
  • Eci：ECI弹性容器。
  • Ip：IP地址。
说明 单次调用最多支持传入40个后端服务器。
Servers.N.ServerIp String 否 192.168.6.6

服务器IP地址。当服务器组为Ip类型时，必须指定IP地址。

说明 单次调用最多支持传入40个后端服务器。
Servers.N.Port Integer 是 443

后端服务器使用的端口。取值范围：1~65535。单次调用最多支持传入40个后端服务器。

说明 该参数暂不支持修改。
Servers.N.Weight Integer 否 100

后端服务器的权重，取值范围：0~100。默认值为100。如果设置权重为0，则不会将请求转发给该后端服务器。

说明 单次调用最多支持传入40个后端服务器。
Servers.N.Description String 否 后端服务器描述

服务器描述信息。

长度限制为2-256个字符，可包含英文字母、数字、中文、半角逗号（,）、半角句号（.）、半角分号（;）、正斜线（/）、at（@）、下划线（_）和短划线（-）。
RegionId String 否 cn-hangzhou

网络型负载均衡实例所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。
DryRun Boolean 否 false

是否只预检此次请求。取值：

  • true：发送检查请求，不会更新服务器配置信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。
ClientToken String 否 123e4567-e89b-12d3-a456-426655440000

客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定，则系统自动使用API请求的 RequestId作为 ClientToken标识。每次API请求的 RequestId可能不一样。

返回数据

名称 类型 示例值 描述
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B45

请求ID。
ServerGroupId String sgp-atstuj3rtoptyui****

服务器组ID。
JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5****

异步任务ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateServerGroupServersAttribute
&ServerGroupId=sgp-atstuj3rtoptyui****
&Servers=[{"ServerId":"ecs-bp67acfmxazb4p****","ServerType":"Ecs","ServerIp":"192.168.6.6","Port":443,"Weight":100,"Description":"后端服务器描述"}]
&RegionId=cn-hangzhou
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateServerGroupServersAttributeResponse>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <ServerGroupId>sgp-atstuj3rtoptyui****</ServerGroupId>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
</UpdateServerGroupServersAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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