1. 接口描述
接口请求域名： ga2.tencentcloudapi.com 。
修改监听器
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyListener。 |
| Version | 是 | String | 公共参数，本接口取值：2025-01-15。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| GlobalAcceleratorId | 是 | String | 全球加速实例ID。 示例值：ga-sfg45k23 |
| ListenerId | 是 | String | 监听器ID。 示例值：lsr-00048c4x |
| Name | 否 | String | 名称，最大长度不能超过60个字节。 示例值：name |
| Description | 否 | String | 描述信息，最大长度不能超过100个字节。 示例值：description |
| IdleTimeout | 否 | Integer | 连接空闲等待时间。 示例值：3 |
| ClientAffinity | 否 | String | 是否开启会话保持。 示例值：Open |
| ClientAffinityTime | 否 | Integer | 会话保持时间。 示例值：1 |
| 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 | 客户端证书。 示例值：["KVfO6PUQ"] |
| GetRealIpType | 否 | String | 四层获取源IP方式。 示例值：ProxyProtocol |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID。 示例值：0a162e80-c98e-47eb-a145-d2015fd490fb |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改监听器
输入示例
POST / HTTP/1.1
Host: ga2.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyListener
<公共请求参数>
{
"GlobalAcceleratorId": "ga-xxxxxxx",
"ListenerId": "lsr-xxxxxx",
"Name": "端口段测试"
}输出示例
{
"Response": {
"RequestId": "30b391b1-6086-4118-a314-4a2b78111fbd",
"TaskId": "099c31b3-82bd-4b1a-bbd1-0ad614b4f54c"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ApplicationLayerListenerCannotCarryParameters | 七层监听器不支持携带参数%(value)s 。 |
| InvalidParameter.ClientAffinityCLose | 会话保持关闭，不支持携带此参数。 |
| InvalidParameter.HttpListenerCannotCarryParameters | Http监听器不支持携带参数%(value)s 。 |
| InvalidParameter.TransportLayerListenerCannotCarryParameters | 四层监听器不支持携带参数%(value)s 。 |
| InvalidParameterValue.InstanceMismatch | 实例对象 %(value)s 关系不匹配。 |
| InvalidParameterValue.Malformed | 参数 %(parameter)s 值 %(value)s 是无效的。正确且完整的值形如 %(template)s。 |
| MissingParameter | 缺少参数错误。 |
| UnsupportedOperation.DuplicateInstanceStatus | 请勿重复操作当前实例状态。 |
| UnsupportedOperation.HttpVersionInconsistent | 监听器和终端节点组的HTTP最大协议版本需要保持一致。 |
| UnsupportedOperation.InstanceNotRunning | 实例不是运行状态，不支持当前操作。 |
| UnsupportedOperation.OnlyTcpListenerSupportToa | 仅TCP监听器，支持通过TOA获取客户端IP。 |
| UnsupportedOperation.TOAFeatureNotEnabled | 当前全球加速实例未开通TOA特性，请联系腾讯云客服申请。 |
