1. 接口描述
接口请求域名： clb.tencentcloudapi.com 。
在一个负载均衡实例下创建监听器。
本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateListener。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| LoadBalancerId | 是 | String | 负载均衡实例 ID。 示例值：lb-cuxw**** |
| Ports.N | 是 | Array of Integer | 要将监听器创建到哪些端口，每个端口对应一个新的监听器。 示例值：["7569","7570"] |
| Protocol | 是 | String | 监听器协议： TCP | UDP | HTTP | HTTPS | TCP_SSL | QUIC。 示例值：TCP |
| ListenerNames.N | 否 | Array of String | 要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数。 示例值：["lis0\n","lis1\n"] |
| HealthCheck | 否 | HealthCheck | 健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。 |
| Certificate | 否 | CertificateInput | 证书相关信息，此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。此参数和MultiCertInfo不能同时传入。 |
| SessionExpireTime | 否 | Integer | 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。 示例值：60 |
| Scheduler | 否 | String | 监听器转发的方式。可选值：WRR、LEAST_CONN 分别表示按权重轮询、最小连接数， 默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。 示例值：WRR |
| SniSwitch | 否 | Integer | 是否开启SNI特性，此参数仅适用于HTTPS监听器。0表示未开启，1表示开启。 示例值：1 |
| TargetType | 否 | String | 后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组。此参数仅适用于TCP/UDP监听器。七层监听器应在转发规则中设置。 示例值：NODE |
| SessionType | 否 | String | 会话保持类型。不传或传NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。此参数仅适用于TCP/UDP监听器。七层监听器应在转发规则中设置。（若选择QUIC_CID，则Protocol必须为UDP，Scheduler必须为WRR，同时只支持ipv4） 示例值：NORMAL |
| KeepaliveEnable | 否 | Integer | 是否开启长连接，此参数仅适用于HTTP/HTTPS监听器，0:关闭；1:开启， 默认关闭。 示例值：0 |
| EndPort | 否 | Integer | 创建端口段监听器时必须传入此参数，用以标识结束端口。同时，入参Ports只允许传入一个成员，用以标识开始端口。【如果您需要体验端口段功能，请通过 工单申请】。 示例值：1000 |
| DeregisterTargetRst | 否 | Boolean | 解绑后端目标时，是否发RST给客户端，此参数仅适用于TCP监听器。 示例值：False |
| MultiCertInfo | 否 | MultiCertInfo | 证书信息，支持同时传入不同算法类型的多本服务端证书；此参数仅适用于未开启SNI特性的HTTPS监听器。此参数和Certificate不能同时传入。 |
| MaxConn | 否 | Integer | 监听器最大连接数，当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持，不传或者传-1表示监听器维度不限速。基础网络实例不支持该参数。 示例值：-1 |
| MaxCps | 否 | Integer | 监听器最大新增连接数，当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持，不传或者传-1表示监听器维度不限速。基础网络实例不支持该参数。 示例值：-1 |
| IdleConnectTimeout | 否 | Integer | 空闲连接超时时间，此参数仅适用于TCP监听器，单位：秒。取值范围：共享型实例和独占型实例支持：300-900，性能容量型实例支持：300-2000。如需设置请通过 工单申请。 示例值：900 |
| SnatEnable | 否 | Boolean | 是否开启SNAT。 示例值：False |
| FullEndPorts.N | 否 | Array of Integer | 全端口段监听器的结束端口 示例值：[600] |
| H2cSwitch | 否 | Boolean | 内网http监听器开启h2c开关 示例值：False |
| SslCloseSwitch | 否 | Boolean | TCP_SSL监听器支持关闭SSL后仍然支持混绑，此参数为关闭开关 示例值：False |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ListenerIds | Array of String | 创建的监听器的唯一标识数组。 示例值：["lbl-d1ubsydq","lbl-4udz130k"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建HTTPS监听器，并绑定已有证书
创建HTTPS监听器，并绑定已有证书
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<公共请求参数>
{
"Protocol": "HTTPS",
"Ports": [
"7572"
],
"Certificate": {
"SSLMode": "UNIDIRECTIONAL",
"CertId": "MsJyaXVm"
},
"LoadBalancerId": "lb-cuxw2rm0"
}输出示例
{
"Response": {
"ListenerIds": [
"lbl-4fbxq45k"
],
"RequestId": "db8ae69f-ebda-402b-8d02-ead459aa6ff9"
}
}示例2 创建TCP监听器的同时设置健康检查信息
创建TCP监听器的同时设置健康检查信息
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<公共请求参数>
{
"HealthCheck": {
"UnHealthNum": "4",
"HealthNum": "4",
"IntervalTime": "7",
"TimeOut": "5",
"HealthSwitch": "1"
},
"Protocol": "TCP",
"Ports": [
"7571"
],
"LoadBalancerId": "lb-cuxw2rm0"
}输出示例
{
"Response": {
"ListenerIds": [
"lbl-lbbxvq26"
],
"RequestId": "fff13c83-dcb5-481a-ba7c-30e92c276c19"
}
}示例3 创建HTTPS监听器，并同时绑定新建的证书
创建HTTPS监听器，并同时绑定新建的证书
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<公共请求参数>
{
"Protocol": "HTTPS",
"Ports": [
"7573"
],
"Certificate": {
"SSLMode": "UNIDIRECTIONAL",
"CertContent": "-----BEGINCERTIFICATE-----\\nMIIEjTCCA3WgAwIBAgIQA4ZHUAVOv4yrszl3lLfo3TANBgkqhkiG9w0BAQsFADBy\\nMQswCQYDVQQGEwJDTjElMCMGA1UEChMcVHJ1c3RBc2lhIFRlY2hub2xvZ2llcywg\\nSW5jLjEdMBsGA1UECxMURG9tYWluIFZhbGlkYXRlZCBTU0wxHTAbBgNVBAMTFFRy\\ndXN0QXNpYSBUTFMgUlNBIENBMB4XDTE4MDEwOTAwMDAwMFoXDTE5MDEwOTEyMDAw\\nMFowFjEUMBIGA1UEAxMLZmx5Zmx5Lm5hbWUwggEiMA0GCSqGSIb3DQEBAQUAA4IB\\nDwAwggEKAoIBAQClpnigB7r3ahv7BMuQw9KzB9Yfq3p+cRUbX9EMRyri2GrJbmrP\\npESP8XQuIn4MZESvePR0r4gGHAHVri8nXzyQw6/m77BT/fIf4cQtEyz61gopDlYq\\nbLTAKVfGFhGVikvQPoItOYbA9/l2YwtDENl8wBhcFrghWTRifnFSC0bNPj1ot5eu\\nL8x5UOZLSa9kaQCm2/RQUBii5w3YBh+HmJgb7HPs8OoHKVScBo6eAyOcr+HNrA8W\\nKsM6r4LpS+Rpfng7+fAKGE+vFsssXfRMBTo0TPp+h8ohuM8xqujbK+T7LMEXNWN9\\n3FGYuuH+qmPvx/gAXFjLARKVyf0IsNnu6TLLAgMBAAGjggF5MIIBdTAfBgNVHSME\\nGDAWgBR/05nzoEcOMQBWViKOt8ye3coBijAdBgNVHQ4EFgQUUCq9/Hmfgli5URvx\\nAbSDNsDCCqcwJwYDVR0RBCAwHoILZmx5Zmx5Lm5hbWWCD3d3dy5mbHlmbHkubmFt\\nZTAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYBBQUHAwEGCCsGAQUFBwMC\\nMEwGA1UdIARFMEMwNwYJYIZIAYb9bAECMCowKAYIKwYBBQUHAgEWHGh0dHBzOi8v\\nd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwCAYGZ4EMAQIBMIGBBggrBgEFBQcBAQR1MHMw\\nJQYIKwYBBQUHMAGGGWh0dHA6Ly9vY3NwMi5kaWdpY2VydC5jb20wSgYIKwYBBQUH\\nMAKGPmh0dHA6Ly9jYWNlcnRzLmRpZ2l0YWxjZXJ0dmFsaWRhdGlvbi5jb20vVHJ1\\nc3RBc2lhVExTUlNBQ0EuY3J0MAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEB\\nADstNGgqYXG6eBDcBGVZk6DnJdS4GYdSzFZgCwt298cPMmZj107VM0QsB5K8V5Zd\\nzJl5c7o4tEXiGP+lk0TVqgP/CkcMXcpxeKB94ldyX9ILii/L4hI9j7hVrLVM1eAn\\nfS66Yg65xIYU8PdFtP3uhI9WdhE3nYRngyoHAAMjIvu0bqGPYbqpnHYp8fmjyetF\\nC9CZcjkqHmwTSpjXuFjbDLx/BXd1Q81TNXwv8alkuXKfIJ5tW2lH372GmQb8I3oI\\nPREP38tlBbmfEu4p7+UzwwuQuD8cEUVuG/x7cUN2uAGiZGoohydrORWm8kqdNY9c\\nYOuRvokzVT4lsaln5LKkKxw=\\n-----ENDCERTIFICATE-----",
"CertName": "my-cert",
"CertKey": "-----BEGINRSAPRIVATEKEY-----\\nMIIEoAIBAAKCAQEApaZ4oAe692ob+wTLkMPSswfWH6t6fnEVG1/RDEcq4thqyW5q\\nz6REj/F0LiJ+DGREr3j0dK+IBhwB1a4vJ188kMOv5u+wU/3yH+HELRMs+tYKKQ5W\\nKmy0wClXxhYRlYpL0D6CLTmGwPf5dmMLQxDZfMAYXBa4IVk0Yn5xUgtGzT49aLeX\\nri/MeVDmS0mvZGkAptv0UFAYoucN2AYfh5iYG+xz7PDqBylUnAaOngMjnK/hzawP\\nFirDOq+C6UvkaX54O/nwChhPrxbLLF30TAU6NEz6fofKIbjPMaro2yvk+yzBFzVj\\nfdxRmLrh/qpj78f4AFxYywESlcn9CLDZ7ukyywIDAQABAoH/KoiULD7g9kAEZrQp\\n1SQusYVRl+E8xeVUdQhHcfCyAUkIAEpZzV2TtLd+DFqKrbTvITBT+vd9sYtdU6K7\\nZ8cMcMoSpNMq+/+wK/b/m4I/6EqEt8HDb0NpSBBEeWUxQM4fumnsFBcXtew6iCtu\\n2vzN7G2IwqUSxI5nbY2SektZ4q5ZRvwEND6gE51uqcqo4i6hA/TYsJLZ63L+Ux0A\\nnm0AsmtMct+DT13NAlpyi6feDQCr1cxcSpqfhfgkWpawJVSxtxKvIn044iRBXb7Y\\nRcW/8YYU1PrTIhhE9AnES7g8mnAgBHRryxuUotXkk7VotTHDbTO0q5KvO2bZ2T6z\\nvQ4BAoGBANqoZE/wAB41wbJ7KwyblxyegI3Y9XYtkPLZlLK+GbCaC9UHNhPqSdaH\\nWPoc3rtm8tOFQc7QMTFtxTLwQ3wEeSO4BFckVHgywuJoGRw1ZYxN8vAzHF1Gc/J1\\nYcX0CDBuKgc0CxlhM7tDAzOgcfJR0EFRVhvLcUAA9hUoeN3EetSBAoGBAMHwnjWc\\n+Y/vBW5yCefQciqppaylwB89H6kds+p0fDlVZQ080VB3b61t6VXOoYAzY4abOjxK\\nAfNyVQcOEuO3gtZp3THK3fkV6bKaNHG41Ang32VW3XGb+MeEkJZwJk4JFbLrz8ln\\nte4M9PjVpYuEQCJZvUjrhd+LJRubTTUXIHFLAoGAU0KJp/KwaNB5aDgERXG9kbU9\\nKEYz+YMSTZbSS1mduKR/2uc7DUxKP3kcRWjW2y8xSZ/VViXqhXLSAzp/x+qAIjzA\\n0lnQHFDf6oxO+3HNsCZCWnpr04yvO+S8jT8GG0LnmASWMVzU8Ppsbq0qlmXW0fhh\\nvIW0IvX6vkXB+FgHmYECgYBrsJe5P4QYV2oVrP8xGL78T51uY89tyTwWZSbtTmdY\\nUsG8+wNjgh6iF8EUY5usG1ztdq58ob+5lcf/FeKJTfI56yjnKDXfxToycYwjhbVA\\nEv0ZQYXPOwOGjmbXEklC1aqV4nlL5enQ2KMCtWeqM/KE4H3JyvZYbeRaEv9pNoFO\\nRwKBgBs+g0d81ufZSuTBlxfivDwrNV6LNzrgnwsTn+H/T7MfyoIEkT3nSGjanQHF\\nwzPYyUpQx5OzNZp1ZEzKeW3GXVWjK+bfKlA7fmrZwDa8/JR6kTfCmc3WRrrQ92yq\\nlFRW1kinLCP5y56SJEBz+DRSYV7ql9wOHyaM23sHkbCF0HAa\\n-----ENDRSAPRIVATEKEY-----"
},
"LoadBalancerId": "lb-cuxw2rm0"
}输出示例
{
"Response": {
"ListenerIds": [
"lbl-bzfmg9m6"
],
"RequestId": "6082314c-030c-429d-9eae-2dc6b159b5b9"
}
}示例4 创建UDP监听器，健康检查方式使用Ping（默认方式）
创建UDP监听器，健康检查方式使用Ping（默认方式）
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<公共请求参数>
{
"HealthCheck": {
"HealthSwitch": "1"
},
"Protocol": "UDP",
"ListenerNames": [
"lis_test"
],
"Ports": [
"432"
],
"LoadBalancerId": "lb-6wlxe9rj"
}输出示例
{
"Response": {
"ListenerIds": [
"lbl-aev333n1"
],
"RequestId": "3b81f03e-6088-448d-abaf-8a487d4f985a"
}
}示例5 创建两个TCP监听器，分别监听7569和7570端口，并分别命名为lis0和lis1
创建两个TCP监听器，分别监听7569和7570端口，并分别命名为lis0和lis1。
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<公共请求参数>
{
"ListenerNames": [
"lis1",
"lis0"
],
"Protocol": "TCP",
"Ports": [
"7570",
"7569"
],
"LoadBalancerId": "lb-cuxw2rm0"
}输出示例
{
"Response": {
"ListenerIds": [
"lbl-d1ubsydq",
"lbl-4udz130k"
],
"RequestId": "8f272cef-14ff-458c-b67e-1bd21bd2942b"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.ResourceInOperating | 正在操作指定的资源，请稍后重试。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.FormatError | 参数格式错误。 |
| InvalidParameter.PortCheckFailed | 监听器端口检查失败，比如端口冲突。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Length | 参数长度错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| ResourceInsufficient | 资源不足。 |
| UnauthorizedOperation | 未授权操作。 |
