文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>应用型负载均衡>监听器相关接口>创建监听器

创建监听器

最近更新时间：2026-07-07 10:57:59

我的收藏

本页目录：

1. 接口描述

接口请求域名： alb.tencentcloudapi.com 。

创建监听器

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateListener。
Version 是 String 公共参数，本接口取值：2025-10-30。
Region 是 String 公共参数，详见产品支持的 地域列表。
DefaultActions.N 是 Array of DefaultAction 默认转发规则动作列表。目前监听器仅支持添加 1 个默认转发规则动作。
ListenerPort 是 Integer 负载均衡实例前端使用的端口。 取值：1~65535。
示例值：80
ListenerProtocol 是 String 监听协议。 取值：HTTP、HTTPS 或 QUIC。
示例值：HTTP
LoadBalancerId 是 String 负载均衡实例 ID，格式为 alb- 后接 8 位字母数字。
示例值：alb-f8q2xk9m
CaCertificateIds.N 否 Array of String 监听器配置的CA证书ID列表。目前监听器仅支持添加 1 个 CA 证书。
当 CaEnabled 参数取值为 true 时，此参数必填。
示例值：["Fm8Wp7x8"]
CaEnabled 否 Boolean 是否开启双向认证。
取值：
true：开启。
false（默认值）：不开启。
示例值：false
CertificateIds.N 否 Array of String 服务器证书 ID 列表。
示例值：["Fm8Wp7x8"]
ClientToken 否 String 客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。
示例值：3e727335-f94c-468f-9989-21759a3b6de8
GzipEnabled 否 Boolean 是否开启Gzip压缩。取值:true(默认值):是。false:否
示例值：false
Http2Enabled 否 Boolean 是否开启HTTP/2特性。HTTP 协议默认 false，HTTPS 协议默认 true。只有 HTTPS 协议支持此参数。
示例值：true
IdleTimeout 否 Integer 连接空闲超时时间。单位：秒。
取值范围：1~600。
默认值：15。
如果在超时时间内一直没有访问请求，负载均衡会断开当前连接，在下次请求到来时创建新的连接。
示例值：15
ListenerName 否 String 自定义监听名称。 长度为 1~255 个字符，必须是中文和无害字符串中的字符， 可包含中文、字母、数字、短划线（-）、正斜线（/）、半角句号（.）、下划线（_）。
示例值：http_listener
RequestTimeout 否 Integer 请求超时时间。单位：秒。
取值：1~600。
默认值：60。
如果在超时时间内后端服务器没有返回响应，负载均衡将放弃等待，并给客户端返回HTTP 504错误码。
示例值：60
SecurityPolicyId 否 String 安全策略 ID，格式为 tls- 后接 8 位字母数字。
示例值：tls-t2ckydug
Tags.N 否 Array of TagInfo 标签列表。最大支持20个。
XForwardedForConfig 否 XForwardedForConfig X-Forwarded-For配置

3. 输出参数

参数名称 类型 描述
ListenerId String 监听器 ID，格式为 lst- 后接 8 位字母数字。
示例值：lst-d9p3k7wa
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建监听器

输入示例

POST / HTTP/1.1
Host: alb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<公共请求参数>

{
    "LoadBalancerId": "alb-f8q2xk9m",
    "ListenerProtocol": "HTTPS",
    "ListenerPort": 80,
    "ListenerName": "443",
    "DefaultActions": [
        {
            "Type": "TargetGroup",
            "TargetGroupConfig": {
                "TargetGroups": [
                    {
                        "TargetGroupId": "lbtg-0zrnc9qa"
                    }
                ]
            }
        }
    ],
    "CertificateIds": [
        "Fm8Wp7x8"
    ],
    "CaEnabled": false,
    "Http2Enabled": false,
    "GzipEnabled": false,
    "RequestTimeout": 60,
    "IdleTimeout": 15,
    "SecurityPolicyId": "tls-t2ckydug",
    "XForwardedForConfig": {
        "XForwardedForMode": "append",
        "XForwardedForProtoEnabled": false,
        "XForwardedForPortEnabled": false,
        "XForwardedForHostEnabled": false,
        "XForwardedForClientSrcPortEnabled": false,
        "XTencentClientSDNEnabled": false,
        "XTencentClientIDNEnabled": false,
        "XTencentClientSerialEnabled": false,
        "XTencentClientVerifyEnabled": false
    }
}

输出示例

{
    "Response": {
        "ListenerId": "lst-d9p3k7wa",
        "RequestId": "e3bc3ab0-e453-4a83-92c4-8fcdda1e08c1"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
UnsupportedOperation.TargetGroupProtocolMismatch 监听器协议与目标组后端转发协议不匹配
UnsupportedOperation.UnsupportedProtocol 监听器协议不支持此操作。
中国站