1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
完成域名创建之后,您可以为域名配置自有证书,也可以使用 EdgeOne 为您提供的 免费证书。
如果您需要配置自有证书,请先将证书上传至 SSL证书控制台,然后在本接口中传入对应的证书 ID。详情参考 部署自有证书至 EdgeOne 域名
。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyHostsCertificate。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点 ID。 |
Hosts.N | 是 | Array of String | 需要修改证书配置的加速域名。 |
Mode | 否 | String | 配置证书的模式,取值有: |
ServerCertInfo.N | 否 | Array of ServerCertInfo | SSL 证书配置,本参数仅在 mode = sslcert 时生效,传入对应证书的 CertId 即可。您可以前往 SSL 证书列表 查看 CertId。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 配置 SSL 证书
针对站点(ZoneId 为 zone-2fgd17m17xw)下的域名(abc.test.com)配置 SSL 证书(CertId 为 cert-244ffgv7m17xw)。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyHostsCertificate
<公共请求参数>
{
"ZoneId": "zone-2fgd17m17xw",
"Hosts": [
"abc.test.com"
],
"Mode": "sslcert",
"ServerCertInfo": [
{
"CertId": "cert-244ffgv7m17xw"
}
]
}
输出示例
{
"Response": {
"RequestId": "5e5a0d0f-52f3-4bad-9bd3-dcf1d5c954e7"
}
}
示例2 配置免费证书
针对站点(ZoneId 为 zone-2fgd17m17xw)下的域名(abc.test.com)配置免费证书。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyHostsCertificate
<公共请求参数>
{
"ZoneId": "zone-2fgd17m17xw",
"Hosts": [
"abc.test.com"
],
"Mode": "eofreecert"
}
输出示例
{
"Response": {
"RequestId": "084d5612-67a7-4aca-aac9-827aa3662b2d"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.CertificateHasExpired | 证书已过期,暂不支持下发过期证书。 |
FailedOperation.CertificateNotFound | 证书不存在。 |
FailedOperation.InvalidZoneStatus | 站点状态不正确。 |
FailedOperation.ModifyFailed | 操作失败。 |
InternalError.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
InternalError.GetRoleError | 获取角色失败。 |
InternalError.ProxyServer | 后端服务器发生未知错误。 |
InternalError.RouteError | 后端服务路由地址错误。 |
InternalError.SystemError | 内部错误-系统错误。 |
InternalError.UnknowError | 未知错误。 |
InvalidParameter.ActionInProgress | 操作频繁,请稍后重试。 |
InvalidParameter.CertNotMatchDomain | HTTPS证书和域名不匹配。 |
InvalidParameter.CertToExpire | HTTPS证书即将过期。 |
InvalidParameter.CertTooShortKeySize | 证书错误。 |
InvalidParameter.CnameWildHostNotAllowApplyCertificate | CNAME模式下无法申请泛域名证书。 |
InvalidParameter.HostStatusNotAllowApplyCertificate | CNAME 未切换或者源站未路由到EO服务器。 |
InvalidParameter.InvalidCertInfo | 证书信息错误。 |
InvalidParameter.InvalidHttpsCertInfo | 无效的HTTPS证书。 |
InvalidParameter.InvalidHttpsTlsVersion | 无效的HTTPS TLS版本。 |
InvalidParameter.ZoneIsGrayPublishing | 站点升级中,暂不支持进行变更操作,请稍后再试。 |
LimitExceeded.RateLimitExceeded | 单位时间内接口请求频率达到限制。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
OperationDenied.DisableZoneNotCompleted | 站点停用未完毕,请稍后再试。 |
OperationDenied.ErrZoneIsAlreadyPaused | 站点处于停用状态,请开启后重试。 |
OperationDenied.VersionControlIsGraying | 存在使用中的测试版本,请将测试版本发布现网或者回滚测试版本再重试。 |
ResourceInUse | 资源被占用。 |
ResourceUnavailable.CertNotFound | 证书不存在或未授权。 |
ResourceUnavailable.HostNotFound | 域名不存在或未开启代理。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |