有奖捉虫:云通信与企业服务文档专题,速来> HOT
文档中心 > API 中心 > 负载均衡 > 监听器相关接口 > 修改负载均衡七层监听器的转发规则

1. 接口描述

接口请求域名: clb.tencentcloudapi.com 。

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyRule。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
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 Integer 会话保持时间。取值范围0或30-86400(单位:秒)。
示例值:75
ForwardType String 负载均衡实例与后端服务之间的转发协议,默认HTTP,可取值:HTTP、HTTPS、GRPC。仅HTTPS监听器该参数有效。
示例值:HTTP
TrpcCallee String TRPC被调服务器路由,ForwardType为TRPC时必填。目前暂未对外开放。
示例值:xyz
TrpcFunc String TRPC调用服务接口,ForwardType为TRPC时必填。目前暂未对外开放。
示例值:abc

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改一条转发规则的健康检查参数及转发策略

修改一条转发规则的健康检查参数及转发策略。

输入示例

https://clb.tencentcloudapi.com/?Action=ModifyRule
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-4fbxq45k
&LocationId=loc-9dr7bsl3
&Url=/bar
&Scheduler=LEAST_CONN
&SessionExpireTime=75
&HealthCheck.HealthSwitch=1
&HealthCheck.IntervalTime=50
&HealthCheck.HealthNum=3
&HealthCheck.UnHealthNum=3
&HealthCheck.HttpCode=7
&HealthCheck.HttpCheckPath=/check
&HealthCheck.HttpCheckDomain=foo.net
&HealthCheck.HttpCheckMethod=GET
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "6d846dfd-27f3-4d74-bc00-ec9ae0570cb0"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.ResourceInOperating 正在操作指定的资源,请稍后重试。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Length 参数长度错误。
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。