1. 接口描述
接口请求域名: gaap.tencentcloudapi.com 。
本接口(ModifyCertificate)用于修改监听器下的域名对应的证书。该接口仅适用于version3.0的通道。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyCertificate。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-29。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ListenerId | 是 | String | 监听器实例ID 示例值:listener-xxx |
Domain | 是 | String | 需要修改证书的域名 示例值:www.test.com |
CertificateId | 是 | String | 新的服务器证书ID。其中: 当CertificateId=default时,表示使用监听器的证书。 示例值:cert-12345678 |
ClientCertificateId | 否 | String | 新的客户端证书ID。其中: 当ClientCertificateId=default时,表示使用监听器的证书。 仅当采用双向认证方式时,需要设置该参数或者PolyClientCertificateIds。 示例值:cert-abcdefgh |
PolyClientCertificateIds.N | 否 | Array of String | 新的多客户端证书ID列表。其中: 仅当采用双向认证方式时,需要设置该参数或ClientCertificateId参数。 示例值:["cert-abcdefgh"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改域名对应的证书
输入示例
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCertificate
<公共请求参数>
{
"Domain": "www.test.com",
"CertificateId": "cert-12345678",
"ClientCertificateId": "cert-abcdefgh",
"ListenerId": "listener-xxx"
}
输出示例
{
"Response": {
"RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.NotEnterpriseAuthorization | 非企业认证客户。 |
AuthFailure.UnauthorizedOperation | 子账户未授权操作。 |
FailedOperation | 操作失败。 |
FailedOperation.DomainStatusNotInRunning | 域名状态为非运行状态,无法操作。 |
FailedOperation.GroupStatusNotInRuning | 通道组状态为非运行状态,无法操作。 |
FailedOperation.ListenerHasTask | 监听器正在操作中,请勿重复操作。 |
FailedOperation.ProxyStatusNotInRuning | 通道处于非运行状态,不能添加监听器。 |
FailedOperation.ProxyVersionNotSupport | 不支持该版本通道。 |
FailedOperation.UserNotConfirmProtocol | 未开通协议。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.CertificateNotMatchDomain | Https证书与域名不匹配。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.AccountViolation | 账号下存在违规资源,详情请查看站内信或邮件。 |
UnknownParameter | 未知参数错误。 |