一、1. 接口描述
申请方式的介绍可参考文档：免费证书申请说明说明：
·仅 CNAME 接入模式可调用该接口来指定免费证书申请方式。NS/DNSPod 托管接入模式都是使用自动验证来申请免费证书，无需调用该接口。
·如果你需要切换免费证书验证方式，你可以重新调用本接口通过修改 VerificationMethod 字段来进行变更。
·同个域名只能申请一本免费证书，在调用本接口后，后台会触发申请免费证书相关任务，你需要在2 天内，完成域名验证信息的相关配置，然后完成证书验证。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。你可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数，本接口取值：ApplyFreeCertificate。 |
| Version | 是 | String | 公共参数，本接口取值：2022-09-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneId | 是 | String | 站点ID。 |
| Domain | 是 | String | 申请免费证书的目标域名。 |
| VerificationMethod | 是 | String | 申请免费证书的验证方式，详细验证方式说明参考免费证书申请方式说明文档 ，相关取值有：http_challenge：HTTP 访问文件验证方式，通过 HTTP 访问域名指定 URL 获取文件信息以完成免费证书申请验证；dns_challenge：DNS 委派验证方式，通过添加指定的主机记录解析指向 EdgeOne 以完成免费证书申请验证。注意：在触发本接口后，你需要根据返回的验证信息，完成验证内容配置。配置完成后，还需要通过检查免费证书申请结果接口进行验证，验证通过后，即可申请成功。在免费证书申请成功后，你可以调用配置域名证书接口为当前域名部署免费证书。 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| DnsVerification | DnsVerification | 当 VerificationMethod 为 dns_challenge 时，域名申请免费证书的相关验证信息。 |
| FileVerification | FileVerification | 当 VerificationMethod 为 http_challenge 时，域名申请免费证书的相关验证信息。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
四、示例1 使用 HTTP 访问文件验证方式申请免费证书
站点（ZoneId 为 zone-2fgd17m17xw）下的域名（abc.test.com）使用 HTTP 访问文件验证方式申请免费证书。
五、输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyFreeCertificate
<公共请求参数>
{
"ZoneId": "zone-2fgd17m17xw",
"Domain": "abc.test.com",
"VerificationMethod": "http_challenge"
}
六、输出示例
{
"Response": {
"RequestId": "064a8c04-2d3e-4c9d-9473-39a8f76276ea",
"FileVerification": {
"Content": "9i8vhsvt9y8y3sx1s2d",
"Path": "/.well-known/teo-verification/yvnu7sesms"
}
}
}
七、示例2 使用 DNS 委派验证方式申请免费证书
站点（ZoneId 为 zone-2fgd17m17xw）下的域名（qwe.test.com） 使用 DNS 委派验证方式申请免费证书。
八、输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyFreeCertificate
<公共请求参数>
{
"ZoneId": "zone-2fgd17m17xw",
"Domain": "qwe.test.com",
"VerificationMethod": "dns_challenge"
}
九、输出示例
{
"Response": {
"RequestId": "064a8c04-2d3e-4c9d-9473-39a8f76276ea",
"DnsVerification": {
"RecordType": "CNAME",
"RecordValue": "_acme-challenge",
"Subdomain": "www.example.com.edgeone.com"
}
}
}
十、腾讯云 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
十三、命令行工具
·Tencent Cloud CLI 3.0
十四、6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。