1. 接口描述
接口请求域名: gaap.tencentcloudapi.com 。
本接口(ModifyDomain)用于监听器下的域名。当通道版本为3.0时,支持对该域名所对应的证书修改。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyDomain。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-29。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ListenerId | 是 | String | 7层监听器ID |
OldDomain | 是 | String | 修改前的域名信息 |
NewDomain | 是 | String | 修改后的域名信息 |
CertificateId | 否 | String | 服务器SSL证书ID,仅适用于version3.0的通道。其中: 不带该字段时,表示使用原证书; 携带该字段时并且CertificateId=default,表示使用监听器证书; 其他情况,使用该CertificateId指定的证书。 |
ClientCertificateId | 否 | String | 客户端CA证书ID,仅适用于version3.0的通道。其中: 不带该字段和PolyClientCertificateIds时,表示使用原证书; 携带该字段时并且ClientCertificateId=default,表示使用监听器证书; 其他情况,使用该ClientCertificateId或PolyClientCertificateIds指定的证书。 |
PolyClientCertificateIds.N | 否 | Array of String | 客户端CA证书ID,仅适用于version3.0的通道。其中: 不带该字段和ClientCertificateId时,表示使用原证书; 携带该字段时并且ClientCertificateId=default,表示使用监听器证书; 其他情况,使用该ClientCertificateId或PolyClientCertificateIds指定的证书。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改7层监听器转发规则域名
修改7层监听器转发规则域名
输入示例
https://gaap.tencentcloudapi.com/?Action=ModifyDomain
&ListenerId=0
&OldDomain=a.a.com
&NewDomain=b.b.com
&CertificateId=default
&<公共请求参数>
输出示例
{
"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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.DomainAlreadyExisted | 该域名在监听器下已使用。 |
FailedOperation.DomainStatusNotInRunning | 域名状态为非运行状态,无法操作。 |
FailedOperation.InstanceStatusNotInRuning | 通道状态为非运行状态,无法操作。 |
FailedOperation.InvalidListenerProtocol | 无效的监听器协议。 |
FailedOperation.ListenerHasTask | 监听器正在操作中,请勿重复操作。 |
FailedOperation.ProxyStatusNotInRuning | 通道处于非运行状态,不能添加监听器。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |