文档

UpdateServerGroupAttribute - 更新服务器组配置

更新时间:

更新服务器组的配置,例如健康检查、会话保持、名称、调度算法和协议等。

接口说明

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

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alb:UpdateServerGroupAttributeWrite
  • ServerGroup
    acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}

请求参数

名称类型必填描述示例值
ServerGroupNamestring

服务器组名称。

长度为 2~128 个英文或中文字符,必须以大小字母或中文开头,可包含数字,半角句号(.),下划线(_)和短划线(-)。

test
Schedulerstring

调度算法。取值:

  • Wrr:加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)也越高。
  • Wlc:加权最小连接数,除了根据每台后端服务器设定的权重值来进行轮询,同时还考虑后端服务器的实际负载(即连接数)。当权重值相同时,当前连接数越小的后端服务器被轮询到的次数(概率)也越高。
  • Sch:一致性哈希,相同哈希因子计算结果的请求将会调度到相同的后端服务器。不配置 UchConfig 参数时,默认哈希因子为源 IP,相同源 IP 地址的请求会分发到同一台后端服务器;配置了 UchConfig 参数时,哈希因子为 URL 参数,相同 URL 参数的请求会分发到同一台后端服务器。
Wrr
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
5A2CFF0E-5718-45B5-9D4D-70B3******
DryRunboolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会修改资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx状态码并直接进行操作。
true
HealthCheckConfigobject

健康检查相关配置结构体。

HealthCheckConnectPortinteger

健康检查的后端服务器的端口。

取值范围:0~65535

设置为 0 时代表使用后端服务器的端口进行健康检查。

说明 当前服务器组 HealthCheckEnabledtrue 时,该参数配置生效。
80
HealthCheckEnabledboolean

是否启用健康检查,取值:

  • true:启用
  • false:不启用
true
HealthCheckHoststring

健康检查域名。字符要求:

  • 长度限制为 1~80 个字符。
  • 可包含小写字母、数字、短划线(-)和半角句号(.)。
  • 至少包含一个半角句号(.),半角句号(.)不能出现在开头或结尾。
  • 最右侧的地域标签,只能包含字母,不能包含数字或短划线(-)。
  • 其他地域标签,短划线(-)不能出现在开头或结尾。
说明 当前服务器组 HealthCheckEnabled 为 true 且 HealthCheckProtocol 设置为 HTTPHTTPS 时该参数生效。(HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。)
example.com
HealthCheckCodesarray

健康检查正常的状态码列表

string

健康检查正常的状态码。

  • HealthCheckProtocol 取值为 HTTPHTTPS 时,HealthCheckCodes 可以选择http_2xx(默认值)、 http_3xxhttp_4xxhttp_5xx。多个状态码用半角逗号(,)分隔。

  • HealthCheckProtocol 取值为 gRPC 时,HealthCheckCodes 状态码范围:0~99,默认值:0。支持范围输入,最多支持 20 个范围值。多个范围值使用半角逗号(,)隔开。

说明 当前服务器组 HealthCheckEnabledtrueHealthCheckProtocol 设置为 HTTPHTTPSgRPC 时该参数生效。(HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。)
200
HealthCheckHttpVersionstring

健康检查 HTTP 协议版本。取值:

  • HTTP1.0
  • HTTP1.1
说明 当前服务器组 HealthCheckEnabled 为 true 且 HealthCheckProtocol 设置为 HTTPHTTPS 时该参数生效。(HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。)
HTTP1.1
HealthCheckIntervalinteger

健康检查的时间间隔。单位:秒。

取值范围:1~50

说明 当前服务器组 HealthCheckEnabledtrue 时,该参数配置生效。
5
HealthCheckMethodstring

健康检查方法。取值:

  • GET:如果响应报文长度超过 8K,会被截断,但不会影响健康检查结果的判定。

  • POST:gRPC 监听健康检查默认采用 POST 方法。

  • HEAD:HTTP 和 HTTPS 监听健康检查默认采用 HEAD 方法。

说明 当前服务器组 HealthCheckEnabled 为 true 且 HealthCheckProtocol 设置为 HTTPHTTPSgRPC 时该参数生效。(HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。)
HEAD
HealthCheckPathstring

健康检查的转发规则路径。

长度限制为 1~80,只能使用字母、数字、字符-/.%?#&=以及扩展字符_;~!()*[]@$^:',+。 URL 开头必须为/

说明 当前服务器组 HealthCheckEnabledtrueHealthCheckProtocol 设置为 HTTPHTTPS 时该参数生效。(HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。)
/test/index.html
HealthCheckProtocolstring

健康检查协议。取值:

  • HTTP:通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。

  • HTTPS:通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。(数据加密,相比 HTTP 更安全。)

  • TCP:通过发送 SYN 握手报文来检测服务器端口是否存活。

  • gRPC:通过发送 POST 或 GET 请求来检查服务器应用是否健康。

说明 HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。
HTTP
HealthCheckTimeoutinteger

接收来自运行状况检查的响应需要等待的时间。如果后端 ECS 在指定的时间内没有正确响应,则判定为健康检查失败。单位:秒。

取值范围:1~300

说明
  • 如果 HealthCHeckTimeout 的值小于 HealthCheckInterval 的值,则 HealthCHeckTimeout 无效,超时时间为 HealthCheckInterval 的值。
    • 当前服务器组 HealthCheckEnabledtrue 时,该参数配置生效。
    3
    HealthyThresholdinteger

    健康检查连续成功多少次后,将后端服务器的健康检查状态由 fail 判定为 success

    取值范围:2~10

    4
    UnhealthyThresholdinteger

    健康检查连续失败多少次后,将后端服务器的健康检查状态由 success 判定为 fail

    取值范围:2~10

    4
    StickySessionConfigobject

    会话保持配置结构体

    Cookiestring

    服务器上配置的 Cookie。

    长度为 1~200 个字符,只能包含 ASCII 英文字母和数字字符,不能包含半角逗号(,)、半角分号(;)或空格,也不能以美元符号($)开头。

    说明 当前服务器组 StickySessionEnabledtrueStickySessionType 配置为 Server 时,该参数生效。
    B490B5EBF6F3CD402E515D22B******
    CookieTimeoutinteger

    Cookie 超时时间。单位:秒。

    取值范围:1~86400

    说明 当前服务器组 StickySessionEnabledtrueStickySessionType 配置为 Insert 时,该参数生效。
    1000
    StickySessionEnabledboolean

    是否启用会话保持。取值:

    • true:是。
    • false:否。
    false
    StickySessionTypestring

    Cookie 的处理方式。取值:

    • Insert:植入 Cookie。 客户端第一次访问时,负载均衡会在返回请求中植入 Cookie(即在 HTTP 或 HTTPS 响应报文中插入 SERVERID),下次客户端携带此 Cookie 访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器上。
    • Server:重写 Cookie。 负载均衡发现用户自定义了 Cookie,将会对原来的 Cookie 进行重写,下次客户端携带新的 Cookie 访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器。
    说明 当前服务器组 StickySessionEnabledtrue 时,该参数生效。
    Insert
    ServerGroupIdstring

    服务器组 ID。

    sgp-atstuj3rtop****
    UpstreamKeepaliveEnabledboolean

    是否开启后端长连接。

    • true:开启

    • false:不开启。

    ServiceNamestring

    仅适用于 ALB Ingress 场景,表示服务器组对应的K8s Service名称。

    test2
    UchConfigobject

    url 一致性 hash 参数配置。

    Typestring

    参数类型。只能填 QueryString。

    QueryString
    Valuestring

    一致性 hash 参数值。

    abc
    ConnectionDrainConfigobject

    连接优雅中断相关配置。

    开启连接优雅中断,在移除后端服务器或者健康检查失败后,负载均衡使现有连接在一定时间内正常传输。

    说明
  • 连接优雅中断功能默认不开放,如需使用,请向商务经理申请。
  • 基础版实例不支持开启连接优雅中断,仅标准版、WAF 增强版实例支持。
  • 服务器类型、IP 类型服务器组支持连接优雅中断,函数计算类型不支持。
  • ConnectionDrainEnabledboolean

    是否开启连接优雅中断。

    • true:开启
    • false:关闭
    false
    ConnectionDrainTimeoutinteger

    连接优雅中断超时时间。

    取值范围:0~900

    300
    SlowStartConfigobject

    慢启动相关配置。

    开启慢启动后,将会在设定的时间段内对新添加到后端服务器组的后端服务器进行预热,转发到该服务器的请求数量线性增加。

    说明
  • 基础版实例不支持开启慢启动,仅标准版、WAF 增强版实例支持。
  • 服务器类型、IP 类型服务器组支持配置慢启动,函数计算类型不支持。
  • 慢启动仅在后端调度算法是加权轮询算法时可开启。
  • SlowStartEnabledboolean

    是否开启慢启动。

    • true:开启
    • false:关闭
    false
    SlowStartDurationinteger

    慢启动持续时间。

    取值范围:30~900

    30

    返回参数

    名称类型描述示例值
    object

    返回数据结构组

    JobIdstring

    异步任务 ID。

    72dcd26b-f12d-4c27-b3af-18f6aed5****
    RequestIdstring

    请求 ID。

    365F4154-92F6-4AE4-92F8-7FF3*****

    示例

    正常返回示例

    JSON格式

    {
      "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
      "RequestId": "365F4154-92F6-4AE4-92F8-7FF3*****"
    }

    错误码

    HTTP status code错误码错误信息描述
    400IncorrectStatus.ServerGroupThe status of %s [%s] is incorrect.服务器组状态无效。
    400Mismatch.LoadBalancerEditionAndConnectionDrainThe %s and %s are mismatched.参数%s和%s不匹配。
    400Mismatch.ServerGroupSchedulerAndSlowStartEnableThe %s and %s are mismatched.参数%s和%s不匹配。
    400QuotaExceeded.ConnectionDrainTimeoutThe quota of %s is exceeded, usage %s/%s.参数%s超过配额限制,当前值%s,配额值%s。
    400UnsupportedFeature.ConnectionDrainThe feature of %s is not supported.不支持%s特性。
    400QuotaExceeded.SlowStartDurationThe quota of %s is exceeded, usage %s/%s.参数%s超过配额限制,当前值%s,配额值%s。
    400UnsupportedFeature.SlowStartThe feature of %s is not supported.不支持%s特性。
    400Mismatch.LoadBalancerEditionAndSlowStartEnableThe %s and %s are mismatched.参数%s和%s不匹配。
    400OperationDenied.UpstreamKeepaliveDisabledThe operation is not allowed because of UpstreamKeepaliveDisabled.不允许更新是否开启后端长连接为关闭状态
    400OperationDenied.UpstreamKeepaliveEnabledThe operation is not allowed because of UpstreamKeepaliveEnabled.不允许更新是否开启后端长连接为开启状态
    404ResourceNotFound.ServerGroupThe specified resource %s is not found.资源%s不存在。

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

    变更历史

    变更时间变更内容概要操作
    2024-02-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:ConnectionDrainConfig
      新增入参:SlowStartConfig
    2023-11-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:UpstreamKeepaliveEnabled
    2023-04-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:UchConfig
    • 本页导读 (1)