- 动态与公告
- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 实践教程
- 运维指南
- 故障处理
- API 文档
- History
- Introduction
- API Category
- Instance APIs
- Listener APIs
- Backend Service APIs
- Target Group APIs
- Redirection APIs
- Other APIs
- DescribeClsLogSet
- CreateLoadBalancerSnatIps
- DeleteLoadBalancerSnatIps
- DescribeLoadBalancerListByCertId
- DescribeQuota
- ModifyLoadBalancersProject
- ReplaceCertForLoadBalancers
- SetLoadBalancerClsLog
- SetLoadBalancerSecurityGroups
- SetLoadBalancerStartStatus
- SetSecurityGroupForLoadbalancers
- CreateClsLogSet
- CreateTopic
- DescribeLoadBalancerTraffic
- DescribeResources
- DescribeTaskStatus
- InquiryPriceCreateLoadBalancer
- InquiryPriceModifyLoadBalancer
- InquiryPriceRenewLoadBalancer
- Classic CLB APIs
- Making API Requests
- Load Balancing APIs
- Data Types
- Error Codes
- CLB API 2017
- 常见问题
- 服务等级协议
- 联系我们
- 词汇表
- 动态与公告
- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 实践教程
- 运维指南
- 故障处理
- API 文档
- History
- Introduction
- API Category
- Instance APIs
- Listener APIs
- Backend Service APIs
- Target Group APIs
- Redirection APIs
- Other APIs
- DescribeClsLogSet
- CreateLoadBalancerSnatIps
- DeleteLoadBalancerSnatIps
- DescribeLoadBalancerListByCertId
- DescribeQuota
- ModifyLoadBalancersProject
- ReplaceCertForLoadBalancers
- SetLoadBalancerClsLog
- SetLoadBalancerSecurityGroups
- SetLoadBalancerStartStatus
- SetSecurityGroupForLoadbalancers
- CreateClsLogSet
- CreateTopic
- DescribeLoadBalancerTraffic
- DescribeResources
- DescribeTaskStatus
- InquiryPriceCreateLoadBalancer
- InquiryPriceModifyLoadBalancer
- InquiryPriceRenewLoadBalancer
- Classic CLB APIs
- Making API Requests
- Load Balancing APIs
- Data Types
- Error Codes
- CLB API 2017
- 常见问题
- 服务等级协议
- 联系我们
- 词汇表
API Description
This API is used to modify the attributes of CLB listeners.
Domain name for API calls: lb.api.qcloud.com
Request Parameters
The list below contains only the API request parameters. Common parameters should be added when you call the API. For more information, see Common Request Parameters. The Action field for this API is ModifyLoadBalancerListener.
| Parameter | Required | Type | Description |
|---|---|---|---|
| loadBalancerId | Yes | String | CLB instance ID, which can be queried via the DescribeLoadBalancers API. |
| loadBalancerId | Yes | String | CLB listener ID, which can be queried via the DescribeLoadBalancerListeners API. |
| listenerName | No | String | Listener name. |
| sessionExpire | No | Int | Session persistence duration. 0: disable. Value range: 30-3600. |
| healthSwitch | No | Int | Whether to enable health check.1: enable; 0: disable. |
| timeOut | No | Int | Response timeout. Value range: 2-60 seconds; This parameter cannot be specified for public network CLB listener with HTTP or HTTPS protocol. |
| intervalTime | No | Int | Interval between health checks. Value range: 5-300 seconds. Default value: 5. |
| healthNum | No | Int | Healthy threshold. Value range: 2-10. |
| unhealthNum | No | Int | Unhealthy threshold. Value range: 2-10. |
| scheduler | No | String | Forwarding method of the CLB listener. This field cannot be passed in together with httpHash. Only public network CLB listeners with TCP or UDP protocol support this field. Valid values: wrr (weighted round robin), least_conn (least connection). |
| httpHash | No | String | Forwarding method of the CLB listener. Only public network CLB listener with HTTP or HTTPS protocol support this field. Valid values: wrr (weighted round robin), ip_hash (forwarding the hash of the source IP to the real server), least_conn (least connection). Default value: wrr. |
| httpCode | No | Int | Return code for the health check of HTTP or HTTPS CLB listeners. Valid range: 1-31. Default value: 31. 1 represents a return code of 1xx (healthy). 2 represents a return code of 2xx (healthy). 4 represents a return code of 3xx (healthy). 8 represents a return code of 4xx (healthy). 16 represents a return code of 5xx (healthy). If there are multiple codes that can show the healthy status, enter the accumulated value corresponding to such codes. |
| httpCheckPath | No | String | Health check path for the public network CLB listener with HTTP or HTTPS protocol. Default is /. It must start with /. |
| SSLMode | No | String | Verification mode of the public network CLB listener with HTTPS protocol. unidirectional: unidirectional verification; mutual: mutual verification. |
| certId | No | String | New server certificate ID of the public network CLB listener with HTTPS protocol. |
| certCaId | No | String | New client certificate ID of the public network CLB listener with HTTPS protocol. |
| certCaContent | No | String | New client certificate content of the public network CLB listener with HTTPS protocol. |
| certCaName | No | String | New client certificate name of the public network CLB listener with HTTPS protocol. |
| certContent | No | String | New server certificate content of the public network CLB listener with HTTPS protocol. |
| certKey | No | String | New server certificate key of the public network CLB listener with HTTPS protocol. |
| certName | No | String | New server certificate name of the public network CLB listener with HTTPS protocol. |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | Int | Common error code. 0: success; other values: failure. For more information, see Common Error Codes. |
| message | String | API-related module error message description. |
| codeDesc | String | Error code. For a successful operation, "Success" is returned. For a failed operation, a message describing the failure is returned. |
| requestId | Int | Request task ID. You can use this field to query the operation status via the DescribeLoadBalancersTaskResult API. |
Example
Request
https://lb.api.qcloud.com/v2/index.php?Action=ModifyLoadBalancerListener &<Common request parameters> loadBalancerId=lb-ltkip4do &listenerId=lbl-6hkiqc6c &SSLMode=unidirectional
Response
{
"code": 0,
"message": "",
"codeDesc": "Success",
"requestId": 18642
}
是
否
本页内容是否解决了您的问题？