免费证书申请

最近更新时间:2024-05-20 02:06:33

我的收藏

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验证,FILE = 文件验证。
DomainName String 域名。
ProjectId Integer 项目 ID。
PackageType String 证书类型,目前仅支持类型83。83 = TrustAsia C1 DV Free。
ContactEmail String 邮箱。
ContactPhone String 手机。
ValidityPeriod String 有效期,默认3个月,目前仅支持3个月。
CsrEncryptAlgo String 加密算法,支持 RSA及ECC。
CsrKeyParameter String 密钥对参数,RSA仅支持2048。ECC仅支持prime256v1。加密算法选择ECC时,此参数必填
CsrKeyPassword String CSR 的加密密码。
Alias String 备注名称。
OldCertificateId String 原证书 ID,用于重新申请。
PackageId String 权益包ID,用于免费证书扩容包使用
DeleteDnsAutoRecord Boolean 签发后是否删除自动域名验证记录, 默认为否;仅域名为DNS_AUTO验证类型支持传参
DnsNames.N Array of String 域名数组(多域名证书可以上传)。

3. 输出参数

参数名称 类型 描述
CertificateId String 证书 ID。
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列表无效。