文档中心 负载均衡 API 文档 应用型负载均衡相关接口 修改应用型负载均衡监听器转发规则

修改应用型负载均衡监听器转发规则

最近更新时间:2019-05-14 17:03:27

1. 接口描述

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyRule
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerId String 负载均衡实例 ID
ListenerId String 应用型负载均衡监听器 ID
LocationId String 要修改的转发规则的 ID。
Url String 转发规则的新的转发路径,如不需修改Url,则不需提供此参数
HealthCheck HealthCheck 健康检查信息
Scheduler String 规则的请求转发方式
SessionExpireTime Integer 会话保持时间

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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