1. 接口描述
接口请求域名： ga2.tencentcloudapi.com 。
创建监听器
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateListener。 |
| Version | 是 | String | 公共参数，本接口取值：2025-01-15。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| GlobalAcceleratorId | 是 | String | 全球加速实例ID。 示例值：ga-sfg45k23 |
| Name | 是 | String | 名称，最大长度不能超过60个字节。 示例值：name |
| PortRanges | 是 | PortRanges | 端口范围。 |
| Description | 否 | String | 描述信息，最大长度不能超过100个字节。 示例值：description |
| ListenerType | 否 | String | 监听类型，默认为智能路由。 示例值：Standard |
| Protocol | 否 | String | 协议，默认为TCP。 示例值：TCP |
| IdleTimeout | 否 | Integer | 连接空闲等待时间。 示例值：3 |
| GetRealIpType | 否 | String | 四层获取源IP方式，支持'TOA', 'ProxyProtocol'。 示例值：TOA |
| ClientAffinity | 否 | String | 是否开启会话保持。 示例值：Open |
| RequestTimeout | 否 | Integer | 请求超时时间。 示例值：1 |
| XForwardedForRealIp | 否 | Boolean | 是否打开七层获取源IP方式。 示例值：true |
| CertificationType | 否 | String | 解析方式。UNIDIRECTIONAL：双向。MUTUAL：单向。 示例值：UNIDIRECTIONAL |
| CipherPolicyId | 否 | String | 加密算法套件。 示例值：tls_cipher_policy_1_0 |
| ServerCertificates.N | 否 | Array of String | 服务器证书。 示例值：["LBNUH4N3"] |
| ClientCaCertificates.N | 否 | Array of String | 客户端证书。 示例值：["LBNUH4N3"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID。 示例值：0a162e80-c98e-47eb-a145-d2015fd490fb |
| ListenerId | String | 监听器ID。 示例值：lsr-00048c4x |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建监听器
输入示例
POST / HTTP/1.1
Host: ga2.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateListener
<公共请求参数>
{
"GlobalAcceleratorId": "ga-80bzejka",
"Name": "garendu-UDP",
"PortRanges": {
"FromPort": 12,
"ToPort": 12
},
"Description": "garendu-UDP-desc",
"ListenerType": "Standard",
"IdleTimeout": 13,
"GetRealIpType": "TOA",
"ClientAffinity": "Open"
}输出示例
{
"Response": {
"ListenerId": "lsr-5lkfom8v",
"RequestId": "3ca6812c-4782-4ca8-8ef7-e3753ab8a4c7",
"TaskId": "85233b38-72cf-49ef-b3e8-c63ac9be774c"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InsufficientResources | 创建该端口段所需资源不足。 |
| InvalidParameter.ApplicationLayerListenerCannotCarryParameters | 七层监听器不支持携带参数%(value)s 。 |
| InvalidParameter.ClientAffinityCLose | 会话保持关闭，不支持携带此参数。 |
| InvalidParameter.HttpListenerCannotCarryParameters | Http监听器不支持携带参数%(value)s 。 |
| InvalidParameter.HttpsListenerCannotCarryParameters | Https监听器不支持携带参数%(value)s 。 |
| InvalidParameter.SinglePort | 仅支持的单个端口。 |
| InvalidParameter.TcpEndpointGroupCarryParameters | 仅Tcp终端节点组支持携带参数%(value)s 。 |
| InvalidParameter.TransportLayerListenerCannotCarryParameters | 四层监听器不支持携带参数%(value)s 。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InstanceName | 实例名称仅支持以大小写字符或中文开头，支持数字、英文句号、或段划线、下划线。 |
| InvalidParameterValue.Malformed | 参数 %(parameter)s 值 %(value)s 是无效的。正确且完整的值形如 %(template)s。 |
| InvalidParameterValue.Range | 参数 %(parameter)s 值 %(value)s 必须在 %(value_range)s 范围内。 |
| InvalidParameterValue.SegmentPortRange | FromPort %(fromPort)s 应小于等于ToPort %(toPort)s。 |
| InvalidParameterValue.TcpSeriesListenerPortEqual | 当前TCP协议系列监听器端口已和存量监听器端口重复。 |
| InvalidParameterValue.ThirdAreaListenerPortEqual | 当前全球加速实例已配置第三方节点加速地域，监听器端口不允许一致。 |
| InvalidParameterValue.ThirdAreaListenerPortSegment | 当前全球加速实例第三方节点不支持配置监听器端口段。 |
| InvalidParameterValue.TooLong | 参数值 %(value)s 长度不能大于 %(max_size)s。 |
| InvalidParameterValue.UdpSeriesListenerPortEqual | 当前UDP协议系列监听器端口已和存量监听器端口重复。 |
| MissingParameter | 缺少参数错误。 |
| UnsupportedOperation.CertificateInvalidStatus | 证书状态是 %(value)s ，不支持当前操作。 |
| UnsupportedOperation.InstanceNotRunning | 实例不是运行状态，不支持当前操作。 |
| UnsupportedOperation.InstanceStateNotAllowedOperate | 当前实例状态不允许此操作。 |
| UnsupportedOperation.ListenerPortSegment | 当前账号不支持配置端口段。 |
