API 名称:ModifyServerGroupAttributes。
API 域名:open.volcengineapi.com 。
API 描述:修改指定服务器组详细信息。
节流限制:每秒最多提交 5 个 API 请求。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数。
名称 | 类型 | 是否必选 | 格式 | 说明 |
---|---|---|---|---|
Action | string | 是 | [a-zA-Z]+ | API 名称,如 ModifyServerGroupAttributes。 |
Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2020-04-01 。 |
X-Expires | int | 否 | 900 | 表示签名的有效时间,单位是秒,默认值是900。 |
在使用该 API 提交请求时,请求参数中可以包含的参数如下。
参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
---|---|---|---|---|
ServerGroupId | String | 是 | 后端服务器组ID。 | rsp-bp1o94dp5i6ea**** |
ServerGroupName | String | 否 | 后端服务器组的名称。
| default_servergroup |
Description | String | 否 | 后端服务器组的描述。
| This is the default servergroup |
Scheduler | String | 否 | 调度算法。取值:
| wrr |
HealthCheck | Array of HealthCheck | 否 | 修改健康检查的相关信息。具体参见下表 HealthCheck 。 | - |
StickySessionConfig | Array of StickySessionConfig | 否 | 更新会话保持功能的配置参数。具体参见下表 StickySessionConfig 。 | - |
HealthCheck
参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
---|---|---|---|---|
HealthCheck.Enabled | String | 否 | 监听器是否开启健康检查功能。取值:
|
on |
HealthCheck.Interval | Integer | 否 | 执行健康检查的时间间隔。 单位:秒,取值:1~300s,默认值为 2。 | 2 |
HealthCheck.Timeout | Integer | 否 | 健康检查的响应超时时间。
| 2 |
HealthCheck.HealthyThreshold | Integer | 否 | 健康检查的健康阈值。
| 3 |
HealthCheck.UnhealthyThreshold | Integer | 否 | 健康检查的不健康阈值。
| 3 |
HealthCheck.Method | String | 否 | 健康检查的方法。只有 Protocol 设置为 HTTP 时该参数生效。取值:
| HEAD |
HealthCheck.Domain | String | 否 | 健康检查的域名,需配置为后端服务器上真实对外提供服务的地址。只有 Protocol 设置为 HTTP 时该参数生效。 | www.test.com |
HealthCheck.URI | String | 否 | 健康检查的路径,需配置为后端服务器上真实对外提供的路径。默认值为 "/"。只有 Protocol 设置为 HTTP 时该参数生效。 | health |
HealthCheck.HttpCode | String | 否 | 健康检查正常的HTTP状态码,多个状态码间用半角逗号","分隔。只有 Protocol 设置为 HTTP 时该参数生效。取值:
| "http_2xx,http_3xx" |
HealthCheck.Protocol | String | 否 | 健康检查协议,当前支持 HTTP、TCP。默认值为 HTTP。 | HTTP |
HealthCheck.HttpVersion | String | 否 | 健康检查HTTP协议版本,只有 Protocol 设置为 HTTP 时该参数生效。取值:
| HTTP1.0 |
StickySessionConfig
参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
---|---|---|---|---|
StickySessionConfig.StickySessionEnabled | String | 否 | 是否开启会话保持。取值如下:
| off |
StickySessionConfig.StickySessionType | String | 否 | 对 Cookie 的处理方式。当 StickySessionConfig.StickySessionEnabled 值为 on 时,此字段参数必填。取值如下:
| insert |
StickySessionConfig.Cookie | String | 否 | 服务配置的会话保持 Cookie 名称。仅在开启会话保持功能并选择重写 Cookie 时有效。 具体规则如下:
| MY_COOKIE |
StickySessionConfig.CookieTimeout | Integer | 否 | 会话保持 Cookie 超时时间。仅在开启会话保持功能并选择植入 Cookie 时有效。 单位:秒。具体规则如下:
| 1000 |
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
RequestId | String | 请求ID。 | 20210811152539010225146063030**** |
GET /?Action=ModifyServerGroupAttributes&ServerGroupId=rsp-1g1f1g8rwii****uxxxn4h9n&ServerGroupName=test&HealthCheck.HttpCode="http_2xx,http_3xx"&Version=2020-04-01 HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing ServiceName: alb
{ "ResponseMetadata": { "RequestId": "20210816110638****2514606306AF947C", "Action": "ModifyServerGroupAttributes", "Version": "2020-04-01", "Service": "alb", "Region": "cn-beijing" }, "Result": { "RequestId": "202108161106****22514606306AF947C", } }
如果响应正文包含 Error 字段,则表示 API 请求失败。此处仅展示当前 API 的错误码,更多错误码请参见公共错误码。
HTTP Code | 错误码 | 错误信息 | 错误描述 |
---|---|---|---|
400 | OperationDenied.AccountArrears | The request on the specified resource is denied due to the account being in arrears status. | 因账号处于欠费状态,对于该资源的操作请求被拒绝。 |
400 | InvalidServerGroupName.Malformed | The specified ServerGroupName is malformed. | 指定的 ServerGroupName 参数格式不合法。 |
400 | InvalidDescription.Malformed | The specified Description is malformed. | 指定的 Description 参数格式不合法。 |
400 | InvalidScheduler.Malformed | The specified Scheduler is malformed. | 指定的 Scheduler 参数格式不合法。 |
400 | InvalidStickySessionConfig.StickySessionEnabled.Malformed | The specified StickySessionConfig.StickySessionEnabled is malformed. | 指定的 StickySessionConfig.StickySessionEnabled 参数格式不合法。 |
400 | InvalidStickySessionConfig.StickySessionType.Malformed | The specified StickySessionConfig.StickySessionType is malformed. | 指定的 StickySessionConfig.StickySessionType 参数格式不合法。 |
400 | MissingParameter | The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'StickySessionConfig.StickySessionType'. | 该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: StickySessionConfig.StickySessionType。 |
400 | MissingParameter | The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'StickySessionConfig.Cookie'. | 该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: StickySessionConfig.Cookie。 |
400 | InvalidStickySessionConfig.Cookie.Malformed | The specified StickySessionConfig.Cookie is malformed. | 指定的 StickySessionConfig.Cookie 参数格式不合法。 |
400 | MissingParameter | The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'StickySessionConfig.CookieTimeout'. | 该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: StickySessionConfig.CookieTimeout。 |
400 | InvalidStickySessionConfig.CookieTimeout.Malformed | The specified StickySessionConfig.CookieTimeout is malformed. | 指定的 StickySessionConfig.CookieTimeout 参数格式不合法。 |
400 | InvalidHealthCheck.Enabled.Malformed | The specified HealthCheck.Enabled is malformed. | 指定的 HealthCheck.Enabled 参数格式不合法。 |
400 | InvalidHealthCheck.Interval.Malformed | The specified HealthCheck.Interval is malformed. | 指定的 HealthCheck.Interval 参数格式不合法。 |
400 | InvalidHealthCheck.Timeout.Malformed | The specified HealthCheck.Timeout is malformed. | 指定的 HealthCheck.Timeout 参数格式不合法。 |
400 | InvalidHealthCheck.HealthyThreshold.Malformed | The specified HealthCheck.HealthyThreshold is malformed. | 指定的 HealthCheck.HealthyThreshold 参数格式不合法。 |
400 | InvalidHealthCheck.UnhealthyThreshold.Malformed | The specified HealthCheck.UnhealthyThreshold is malformed. | 指定的 HealthCheck.UnhealthyThreshold 参数格式不合法。 |
400 | InvalidHealthCheck.Protocol.Malformed | The specified HealthCheck.Protocol is malformed. | 指定的 HealthCheck.Protocol 参数格式不合法。 |
400 | InvalidHealthCheck.Method.Malformed | The specified HealthCheck.Method is malformed. | 指定的 HealthCheck.Method 参数格式不合法。 |
400 | InvalidHealthCheck.URI.Malformed | The specified HealthCheck.URI is malformed. | 指定的 HealthCheck.URI 参数格式不合法。 |
400 | InvalidHealthCheck.HttpCode.Malformed | The specified HealthCheck.HttpCode is malformed. | 指定的 HealthCheck.HttpCode 参数格式不合法。 |
400 | InvalidHealthCheck.Domain.Malformed | The specified HealthCheck.Domain is malformed. | 指定的 HealthCheck.Domain 参数格式不合法。 |
400 | InvalidLoadBalancer.InvalidStatus | The related LoadBalancer is not in the correct status for the request. | 关联的 ALB 实例所处状态无法响应该请求。 |
400 | InvalidServerGroup.InvalidStatus | The specified ServerGroup is not in the correct status for the request. | 指定的服务器组所处状态无法响应该请求。 |
400 | InvalidHealthCheck.HttpVersion.Malformed | The specified HealthCheck.HttpVersion is malformed. | 指定的 HealthCheck.HttpVersion 参数格式不合法。 |
400 | MissingParameter | The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'HealthCheck.Domain'. | 该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: HealthCheck.Domain。 |
404 | InvalidServerGroup.NotFound | The specified ServerGroup does not exist. | 指定的服务器组不存在。 |