修改目标虚拟服务器组的转发规则。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
slb:SetRule | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 负载均衡实例的地域 ID。 您可以通过调用 DescribeRegions 接口查询地域 ID。 | cn-hangzhou |
RuleId | string | 是 | 转发规则 ID。 | rule-3ejhkt**** |
VServerGroupId | string | 否 | 转发规则的目标服务器组 ID。 | rsp-cige6**** |
RuleName | string | 否 | 转发规则名称,长度限制为 1~40 个字符,支持中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)这些字符。 说明
同一个监听内不同规则的名称必须唯一。
| doctest |
ListenerSync | string | 否 | 是否继承监听的健康检查、会话保持和调度算法配置。取值:
| off |
Scheduler | string | 否 | 调度算法。取值:
说明
在 ListenerSync 为 off 时必选且有效。
| wrr |
StickySession | string | 否 | 是否开启会话保持,取值:
在 ListenerSync 为 off 时必选且有效。 | off |
StickySessionType | string | 否 | Cookie 的处理方式。取值:
说明
StickySession 为 on 时必选且有效。
| insert |
CookieTimeout | integer | 否 | Cookie 超时时间。单位:秒。取值范围:1~86400。 说明
当 StickySession 为 on 且 StickySessionType 为 insert 时必选且有效。
| 123 |
Cookie | string | 否 | 服务器上配置的 Cookie。 长度为 1~200 个字符,只能包含 ASCII 英文字母和数字字符,不能包含半角逗号(,)、半角分号(;)或空格,也不能以美元($)开头。 说明
当 StickySession 为 on 且 StickySessionType 为 server 时必选且有效。
| 23ffsa |
HealthCheck | string | 否 | 是否开启健康检查。取值:
说明
ListenerSync 为 off 时必选且有效,其他情况会忽略此参数。
| off |
HealthCheckDomain | string | 否 | 用于健康检查的域名,取值:
说明
** HealthCheck**为 on 时有效。
| $_ip |
HealthCheckURI | string | 否 | 用于健康检查的 URI。 说明
HealthCheck 为 on 时必选且有效。
| /example |
HealthyThreshold | integer | 否 | 健康检查连续成功多少次后,将后端服务器的健康检查状态由失败判定为成功。 取值范围:2~10。 说明
HealthCheck 为 on 时必选且有效。
| 4 |
UnhealthyThreshold | integer | 否 | 健康检查连续失败多少次后,将后端服务器的健康检查状态由成功判定为失败。 取值范围:2~10。 说明
HealthCheck 为 on 时必选且有效。
| 4 |
HealthCheckTimeout | integer | 否 | 接收来自运行状况检查的响应需要等待的时间。如果后端 ECS 在指定的时间内没有正确响应,则判定为健康检查失败。单位:秒。取值范围:1~300。 说明
HealthCheck 为 on 时必选且有效。
| 20 |
HealthCheckInterval | integer | 否 | 健康检查的时间间隔。单位:秒。取值范围:1~50。 说明
HealthCheck 为 on 时必选且有效。
| 20 |
HealthCheckConnectPort | integer | 否 | 健康检查使用的端口。取值范围:1~65535。 说明
HealthCheck 为 on 时有效。
| 80 |
HealthCheckHttpCode | string | 否 | 健康检查正常的 HTTP 状态码,多个状态码用半角逗号(,)分割。 取值:http_2xx或http_3xx 或http_4xx或http_5xx。 说明
HealthCheck 为 on 时必选且有效。
| http_2xx |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified VServerGroupId does not belong to the LoadBalancerId of the rule. | 指定的服务器组和当前转发规则不属于同一个负载均衡实例。 |
400 | InvalidParameter.RegionNotSupport | The region does not support the parameter: %s. | 当前区域不支持指定参数。 |
访问错误中心查看更多错误码。