API 文档

修改HTTPS监听器配置

最近更新时间:2020-09-02 08:09:54

1. 接口描述

接口请求域名: gaap.tencentcloudapi.com 。

该接口(ModifyHTTPSListenerAttribute)用于修改HTTPS监听器配置,当前不支持通道组和v1版本通道。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyHTTPSListenerAttribute。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,本接口不需要传递此参数。
ListenerId String 监听器ID
ProxyId String 通道ID, 若为单通道监听器,此项必须填写
ListenerName String 修改后的监听器名称
ForwardProtocol String 监听器后端转发与源站之间的协议类型
CertificateId String 修改后的监听器服务器证书ID
ClientCertificateId String 修改后的监听器客户端证书ID,不支持多客户端证书,多客户端证书新采用PolyClientCertificateIds字段
PolyClientCertificateIds.N Array of String 新字段,修改后的监听器客户端证书ID

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改HTTPS监听器配置

修改HTTPS监听器配置

输入示例

https://gaap.tencentcloudapi.com/?Action=ModifyHTTPSListenerAttribute
&InstanceId=link-3d85gh
&ListenerId=listener-o0f3at99
&ListenerName=test-2
&ForwardProtocol=HTTP
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "38fab584-8d14-4e2c-988c-4acdabbf2dff"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.GroupStatusNotInRuning 通道组状态为非运行状态,无法操作。
FailedOperation.InstanceStatusNotInRuning 通道状态为非运行状态,无法操作。
FailedOperation.ListenerHasTask 监听器正在操作中,请勿重复操作。
FailedOperation.NotSupportOldVersionProxy 仅支持Version2.0的通道。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
目录