1. 接口描述
接口请求域名： teo.tencentcloudapi.com 。
该接口用于验证免费证书并获取免费证书申请结果。如果验证通过，可通过该接口查询到对应域名申请的免费证书信息，如果申请失败，该接口将返回对应的验证失败信息。
在触发申请免费证书接口后，您可以通过本接口检查免费证书申请结果。在免费证书申请成功后， 还需要通过配置域名证书接口配置，才能将免费证书部署至加速域上。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CheckFreeCertificateVerification。 |
| Version | 是 | String | 公共参数，本接口取值：2022-09-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneId | 是 | String | 站点 ID。 |
| Domain | 是 | String | 加速域名，该域名为申请免费证书时使用的域名。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CommonName | String | 免费证书申请成功时，该证书颁发给的域名。 注意：一个域名只允许申请一本免费证书， 如果已经有泛域名申请了免费证书的情况下，其子域名会匹配使用该泛域名证书。 |
| SignatureAlgorithm | String | 免费证书申请成功时，该证书使用的签名算法，当前仅支持 RSA 2048。 |
| ExpireTime | Timestamp ISO8601 | 免费证书申请成功时，该证书的过期时间。时间为世界标准时间（UTC）， 遵循 ISO 8601 标准的日期和时间格式。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 检查免费证书申请结果，免费证书申请失败
针对站点（ZoneId 为 zone-28v607hq8d3m）下的域名（cc.xzone.cloud）在触发申请免费证书后，检查免费证书是否申请成功。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckFreeCertificateVerification
<公共请求参数>
{
"ZoneId": "zone-28v607hq8d3m",
"Domain": "cc.xzone.cloud"
}输出示例
{
"Response": {
"Error": {
"Code": "ResourceUnavailable.RecordUnExpected",
"Message": "无法正确检测到验证值，请检查当前域名是否配置了分区域解析或者安全策略拦截。"
},
"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"
}
}示例2 检查免费证书申请结果，免费证书申请成功
针对站点（ZoneId 为 zone-28v607hq8d3m）下的域名（aa.xzone.cloud）在触发申请免费证书后，检查免费证书是否申请成功。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckFreeCertificateVerification
<公共请求参数>
{
"ZoneId": "zone-28v607hq8d3m",
"Domain": "aa.xzone.cloud"
}输出示例
{
"Response": {
"RequestId": "dc1ba58b-4e4e-4a71-bed6-2b777c48d17e",
"CommonName": "aa.xzone.cloud",
"SignatureAlgorithm": "RSA 2048",
"ExpireTime": "2025-07-31T07:06:57Z"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
