ModifyRule

最近更新时间: 2024-12-21 13:01:31

1. 接口描述

接口请求域名: clb.api3.gsesgpucloud.com。

ModifyRule 接口用来修改负载均衡七层监听器下的转发规则的各项属性,包括转发路径、健康检查属性、转发策略等。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。

默认接口请求频率限制:20次/秒。

接口更新时间:2019-10-22 20:16:49。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:ModifyRule
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
LoadBalancerId String 负载均衡实例 ID
示例值: lb-cuxw2rm0
ListenerId String 负载均衡监听器 ID
示例值: lbl-4fbxq45k
LocationId String 要修改的转发规则的 ID。
示例值: loc-9dr7bsl3
Url String 转发规则的新的转发路径,如不需修改Url,则不需提供此参数
示例值: /bar
HealthCheck HealthCheck 健康检查信息
示例值:查看
Scheduler String 规则的请求转发方式,可选值:WRR、LEAST_CONN、IP_HASH
分别表示按权重轮询、最小连接数、按IP哈希, 默认为 WRR。
示例值: LEAST_CONN
SessionExpireTime Int64 会话保持时间
示例值: 75
ForwardType String 负载均衡实例与后端服务之间的转发协议,默认HTTP,可取值:HTTP、HTTPS
示例值: HTTP
TargetType String 后端目标类型,NODE表示绑定普通节点
示例值: NODE

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误
InternalError 内部错误
UnauthorizedOperation 未授权操作
FailedOperation 操作失败
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue.Length 参数长度错误。
MissingParameter 缺少参数错误。