申请免费证书

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

申请免费证书时，如果您需要通过使用 DNS 委派验证或者文件验证进行申请，您可以调用该接口来进行发起证书申请并根据申请方式来获取对应的验证内容。调用接口的顺序如下：
第一步：调用 ApplyFreeCertificate，指定申请免费证书的校验方式，获取验证内容；
第二步：为相应域名按照验证内容配置；
第三步：调用CheckFreeCertificateVerification 验证，验证通过后即完成免费证书申请；
第四步：调用ModifyHostsCertificate，下发域名证书为使用 EdgeOne 免费证书配置。

申请方式的介绍可参考文档：免费证书申请说明
说明：

• 仅 CNAME 接入模式可调用该接口来指定免费证书申请方式。NS/DNSPod 托管接入模式都是使用自动验证来申请免费证书，无需调用该接口。
• 如果您需要切换免费证书验证方式，您可以重新调用本接口通过修改 VerificationMethod 字段来进行变更。
• 同个域名只能申请一本免费证书，在调用本接口后，后台会触发申请免费证书相关任务，您需要在2 天内，完成域名验证信息的相关配置，然后完成证书验证。

默认接口请求频率限制：20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

3. 输出参数

4. 示例

示例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"
        }
    }
}

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。