文档平台 API 中心 负载均衡 应用型负载均衡相关接口 转发规则相关接口 修改应用型负载均衡监听器转发规则的健康检查及转发路径

修改应用型负载均衡监听器转发规则的健康检查及转发路径

最近更新时间:2018-06-25 15:46:50

接口描述

ModifyLoadBalancerRulesProbe 接口用来修改应用型负载均衡七层监听器转发规则的健康检查及转发路径。

接口访问域名:lb.api.qcloud.com

请求参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为 ModifyLoadBalancerRulesProbe。

参数名称 必选 类型 描述
loadBalancerId String 负载均衡实例 ID,可通过 DescribeLoadBalancers 接口同时入参 forward 字段为 1 或者 -1 来查询。
listenerId String 应用型负载均衡监听器 ID,可通过 DescribeForwardLBListeners 接口查询。
locationId String 应用型负载均衡监听器转发规则 ID。可通过 DescribeForwardLBListeners 接口查询。
url String 应用型负载均衡监听器转发规则的路径,长度限制为:1~80,使用格式有两种:无修饰符格式,有修饰符格式。修饰符可以使用的有:~、 ~* 、 ^~ 、 = 。其中 ~ 表示接下来的表达式为大小写敏感的正则表达式,~* 修饰符表示大小写不敏感的正则表达式。^~ 修饰符表示如果该表达式被认定为最佳匹配,那么不再进行以下的搜索匹配。=表示精确匹配,只有请求与该表达式完全相同才满足该转发。非正则表达式可用的字符包括字母、数字、_.-=/
sessionExpire Int 应用型负载均衡监听器转发规则的会话保持时间,0 表示关闭,可选值:30~3600。
healthSwitch Int 应用型负载均衡监听器转发规则的健康检查,1:开启,0:关闭。
intervalTime Int 应用型负载均衡监听器转发规则的检查间隔,可选值:5~300。
healthNum Int 应用型负载均衡监听器转发规则的健康阈值,可选值:2~10。
unhealthNum Int 应用型负载均衡监听器转发规则的不健康阈值,可选值:2~10。
httpHash Int 应用型负载均衡监听器转发规则的转发方式,可选值:wrr、ip_hash、least_conn。
httpCode Int 应用型负载均衡监听器转发规则的健康状态码。可选值:1~31,默认 31。
1 表示探测后返回值 1xx 表示健康,2 表示返回 2xx 表示健康,4 表示返回 3xx 表示健康,8 表示返回 4xx 表示健康,16 表示返回 5xx 表示健康。若希望多种码都表示健康,则将相应的值相加。
httpCheckPath String 应用型负载均衡监听器转发规则的探测路径,默认/,必须以/开头。长度限制为:1~80,支持字符集:a~z0~9_.-=/
httpCheckMethod String HTTP 请求方式,分为‘HEAD’、'GET'两种方式。
httpCheckDomain String 健康检查域名,为标准域名,支持字符集:a~z0~9_.-

返回参数

参数名称 类型 描述
code Int 公共错误码,0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误码,成功返回 Success,失败有相应的英文说明。
requestId Int 请求任务 ID,可根据 DescribeLoadBalancersTaskResult 接口查询操作状态。

示例

请求

https://lb.api.qcloud.com/v2/index.php?Action=ModifyLoadBalancerRulesProbe
&<公共请求参数>
&loadBalancerId=lb-6efswuxa
&listenerId=lbl-20cxbf40
&locationId=loc-mpoupana
&url=/zero

返回

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "requestId": 28078
}