SSL 证书
开发与运维产品文档捉虫活动邀您参加！> HOT
文档中心>SSL 证书>API 文档>证书相关接口>免费证书申请

免费证书申请

最近更新时间：2025-02-17 01:27:08

我的收藏

本页目录：

1. 接口描述

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

本接口（ApplyCertificate）用于免费证书申请。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ApplyCertificate。
Version 是 String 公共参数，本接口取值：2019-12-05。
Region 否 String 公共参数，本接口不需要传递此参数。
DvAuthMethod 是 String 证书域名验证方式：
DNS_AUTO： 自动添加域名DNS验证， 需用户域名解析托管在『云解析DNS』，且与申请证书归属同一个腾讯云账号
DNS：手动添加域名DNS验证，需用户手动去域名解析服务商添加验证值
FILE：手动添加域名文件验证。 需要用户手动在域名站点根目录添加指定路径文件进行文件验证， http&https任一通过即可；且域名站点需海外CA机构能访问， 具体访问白名单为：64.78.193.238，216.168.247.9，216.168.249.9，54.189.196.217
示例值：DNS_AUTO
DomainName 是 String 证书绑定的域名。
示例值：tencent.com
ProjectId 否 Integer 证书关联的项目 ID。 默认为0（默认项目）
示例值：0
PackageType 否 String 证书类型， 可不传，目前仅支持类型83。83 = TrustAsia C1 DV Free。
示例值：83
ContactEmail 否 String 证书订单关联邮箱。默认为腾讯云账号邮箱， 不存在则关联固定邮箱
示例值：ssl@tencent.com
ContactPhone 否 String 证书关联手机号码， 不存在则关联固定手机号码
示例值：188**778
ValidityPeriod 否 String 证书有效期，默认3（月），目前仅支持3个月。
示例值：3
CsrEncryptAlgo 否 String 加密算法，取值为ECC、RSA， 默认为RSA
示例值：RSA
CsrKeyParameter 否 String 密钥对参数，RSA仅支持2048。ECC仅支持prime256v1。加密算法选择ECC时，此参数必填
示例值：2048
CsrKeyPassword 否 String 私钥密码， 目前仅使用在生成jks、pfx格式证书时密码； 其他格式私钥证书未加密
示例值：**
Alias 否 String 证书别名
示例值：**
OldCertificateId 否 String 旧证书 ID，用于证书续费（证书有效期在30天内，且未过期），会建立续费关系， 可用于托管； 不传则表示新申请证书
示例值：LqQxgqUe
PackageId 否 String 权益包ID，用于免费证书扩容包使用， 免费证书扩容包已下线
示例值：pid****xsj
DeleteDnsAutoRecord 否 Boolean 签发后是否删除自动域名验证记录， 默认为否；仅域名为DNS_AUTO验证类型支持传参
示例值：true
DnsNames.N 否 Array of String 证书绑定的其他域名，待开放。目前不支持此参数
示例值：["www.tencent.com"]

3. 输出参数

参数名称 类型 描述
CertificateId String 新申请成功的证书 ID。
示例值：LqQxgqUe
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 免费证书申请

免费证书申请

输入示例

POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyCertificate
<公共请求参数>

{
    "DvAuthMethod": "DNS_AUTO",
    "DomainName": "wgc.red"
}

输出示例

{
    "Response": {
        "CertificateId": "a9TsmZkL",
        "RequestId": "0b39eaa4-f938-476d-9b26-19fb07b80936"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
FailedOperation.AuthError 请检查是否有权限。
FailedOperation.CancelOrderFailed 取消订单失败。
FailedOperation.CannotBeDeletedIssued 该证书已颁发， 不能删除。
FailedOperation.CannotBeDeletedWithinHour 免费证书申请1小时内不允许删除。
FailedOperation.CannotGetOrder 获取订单信息失败，请稍后重试。
FailedOperation.CertificateInvalid 证书不符合标准。
FailedOperation.CertificateMismatch 证书与私钥不对应。
FailedOperation.CertificateNotFound 证书不存在。
FailedOperation.ExceedsFreeLimit 免费证书数量超出限制。
FailedOperation.InvalidCertificateStatusCode 证书状态不正确。
FailedOperation.InvalidParam 参数有误。
FailedOperation.MainDomainCertificateCountLimit 该主域（%s）下申请的免费证书数量已达到%s个上限，请购买付费证书。
FailedOperation.NetworkError 当前 CA 机构访问繁忙，请稍后重试。
FailedOperation.NoProjectPermission 您没有该项目的操作权限。
FailedOperation.NoRealNameAuth 尚未通过实名认证。
FailedOperation.OrderAlreadyReplaced 该订单已重签发。
FailedOperation.OrderReplaceFailed 重颁发失败。
FailedOperation.PackageCountLimit 剩余权益点不足。
FailedOperation.PackageExpired 权益包已过期。
FailedOperation.PackageNotFound 权益包不存在。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.PackageIdsInvalid 权益点ID列表无效。
中国站
文档活动
message-icon联系我们
目录