API 中心
开发与运维产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>SSL 证书>证书相关接口>获取证书信息

获取证书信息

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

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeCertificate）用于获取证书信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeCertificate。
Version 是 String 公共参数，本接口取值：2019-12-05。
Region 否 String 公共参数，本接口不需要传递此参数。
CertificateId 是 String 证书 ID。
示例值：heysh**hh

3. 输出参数

参数名称 类型 描述
OwnerUin String 用户 UIN。
注意：此字段可能返回 null，表示取不到有效值。
示例值：278389292
ProjectId String 项目 ID。
注意：此字段可能返回 null，表示取不到有效值。
示例值：7388392
From String 证书来源：
trustasia：亚洲诚信，
upload：用户上传。
wosign：沃通
sheca：上海CA
注意：此字段可能返回 null，表示取不到有效值。
示例值：upload
CertificateType String 证书类型：CA = 客户端证书，SVR = 服务器证书。
注意：此字段可能返回 null，表示取不到有效值。
示例值：CA
PackageType String 证书套餐类型：
null：用户上传证书（没有套餐类型），
2：TrustAsia TLS RSA CA，
3：SecureSite 增强型企业版（EV Pro），
4：SecureSite 增强型（EV），
5：SecureSite 企业型专业版（OV Pro），
6：SecureSite 企业型（OV），
7：SecureSite 企业型（OV）通配符，
8：Geotrust 增强型（EV），
9：Geotrust 企业型（OV），
10：Geotrust 企业型（OV）通配符，
11：TrustAsia 域名型多域名 SSL 证书，
12：TrustAsia 域名型（DV）通配符，
13：TrustAsia 企业型通配符（OV）SSL 证书（D3），
14：TrustAsia 企业型（OV）SSL 证书（D3），
15：TrustAsia 企业型多域名 （OV）SSL 证书（D3），
16：TrustAsia 增强型 （EV）SSL 证书（D3），
17：TrustAsia 增强型多域名（EV）SSL 证书（D3），
18：GlobalSign 企业型（OV）SSL 证书，
19：GlobalSign 企业型通配符 （OV）SSL 证书，
20：GlobalSign 增强型 （EV）SSL 证书，
21：TrustAsia 企业型通配符多域名（OV）SSL 证书（D3），
22：GlobalSign 企业型多域名（OV）SSL 证书，
23：GlobalSign 企业型通配符多域名（OV）SSL 证书，
24：GlobalSign 增强型多域名（EV）SSL 证书，
25：Wotrus 域名型证书，
26：Wotrus 域名型多域名证书，
27：Wotrus 域名型通配符证书，
28：Wotrus 企业型证书，
29：Wotrus 企业型多域名证书，
30：Wotrus 企业型通配符证书，
31：Wotrus 增强型证书，
32：Wotrus 增强型多域名证书，
33：WoTrus-国密域名型证书，
34：WoTrus-国密域名型证书（多域名），
35：WoTrus-国密域名型证书（通配符），
37：WoTrus-国密企业型证书，
38：WoTrus-国密企业型证书（多域名），
39：WoTrus-国密企业型证书（通配符），
40：WoTrus-国密增强型证书，
41：WoTrus-国密增强型证书（多域名），
42：TrustAsia-域名型证书（通配符多域名），
43：DNSPod-企业型(OV)SSL证书
44：DNSPod-企业型(OV)通配符SSL证书
45：DNSPod-企业型(OV)多域名SSL证书
46：DNSPod-增强型(EV)SSL证书
47：DNSPod-增强型(EV)多域名SSL证书
48：DNSPod-域名型(DV)SSL证书
49：DNSPod-域名型(DV)通配符SSL证书
50：DNSPod-域名型(DV)多域名SSL证书
51：DNSPod（国密）-企业型(OV)SSL证书
52：DNSPod（国密）-企业型(OV)通配符SSL证书
53：DNSPod（国密）-企业型(OV)多域名SSL证书
54：DNSPod（国密）-域名型(DV)SSL证书
55：DNSPod（国密）-域名型(DV)通配符SSL证书
56：DNSPod（国密）-域名型(DV)多域名SSL证书
57：SecureSite 企业型专业版多域名(OV Pro)
58：SecureSite 企业型多域名(OV)
59：SecureSite 增强型专业版多域名(EV Pro)
60：SecureSite 增强型多域名(EV)
61：Geotrust 增强型多域名(EV)
75：SecureSite 企业型(OV)
76：SecureSite 企业型(OV)通配符
77：SecureSite 增强型(EV)
78：Geotrust 企业型(OV)
79：Geotrust 企业型(OV)通配符
80：Geotrust 增强型(EV)
81：GlobalSign 企业型（OV）SSL证书
82：GlobalSign 企业型通配符 （OV）SSL证书
83：TrustAsia C1 DV Free
85：GlobalSign 增强型 （EV）SSL证书
88：GlobalSign 企业型通配符多域名 （OV）SSL证书
89：GlobalSign 企业型多域名 （OV）SSL证书
90：GlobalSign 增强型多域名（EV） SSL证书
91：Geotrust 增强型多域名(EV)
92：SecureSite 企业型专业版多域名(OV Pro)
93：SecureSite 企业型多域名(OV)
94：SecureSite 增强型专业版多域名(EV Pro)
95：SecureSite 增强型多域名(EV)
96：SecureSite 增强型专业版(EV Pro)
97：SecureSite 企业型专业版(OV Pro)
98：CFCA 企业型(OV)SSL证书
99：CFCA 企业型多域名(OV)SSL证书
100：CFCA 企业型通配符(OV)SSL证书
101：CFCA 增强型(EV)SSL证书
注意：此字段可能返回 null，表示取不到有效值。
示例值：2
ProductZhName String 证书产品名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：TrustAsia C1 DV Free
Domain String 域名。
注意：此字段可能返回 null，表示取不到有效值。
示例值：www.**.com
Alias String 备注名称。
注意：此字段可能返回 null，表示取不到有效值。
示例值：hello
Status Integer 证书状态：0 = 审核中，1 = 已通过，2 = 审核失败，3 = 已过期，4 = 自动添加DNS记录，5 = 企业证书，待提交资料，6 = 订单取消中，7 = 已取消，8 = 已提交资料， 待上传确认函，9 = 证书吊销中，10 = 已吊销，11 = 重颁发中，12 = 待上传吊销确认函，13 = 免费证书待提交资料。14 = 证书已退款。 15 = 证书迁移中
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
StatusMsg String 状态信息。 取值范围：
//通用状态信息
1、PRE-REVIEWING：预审核中
2、LEGAL-REVIEWING：法务审核中
3、CA-REVIEWING：CA审核中
4、PENDING-DCV：域名验证中
5、WAIT-ISSUE：等待签发（域名验证已通过）
//证书审核失败状态信息
1、订单审核失败
2、CA审核失败，域名未通过安全审查
3、域名验证超时，订单自动关闭，请您重新进行证书申请
4、证书资料未通过证书CA机构审核，审核人员会致电您证书预留的联系方式，请您留意来电。后续可通过“修改资料”重新提交资料
待持续完善
注意：此字段可能返回 null，表示取不到有效值。
示例值：CA-REVIEWING
VerifyType String 验证类型：DNS_AUTO = 自动DNS验证，DNS = 手动DNS验证，FILE = 文件验证，DNS_PROXY = DNS代理验证。FILE_PROXY = 文件代理验证
注意：此字段可能返回 null，表示取不到有效值。
示例值：DNS_AUTO
VulnerabilityStatus String 漏洞扫描状态。
注意：此字段可能返回 null，表示取不到有效值。
示例值：INACTIVE
CertBeginTime String 证书生效时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值：2024-11-27 08:00:00
CertEndTime String 证书失效时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值：2025-02-26 07:59:59
ValidityPeriod String 证书有效期：单位(月)。
注意：此字段可能返回 null，表示取不到有效值。
示例值：3
InsertTime String 申请时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值：2024-11-27 17:44:36
OrderId String 订单 ID。
注意：此字段可能返回 null，表示取不到有效值。
示例值：HyJ4b85G_mZOLxSuw
CertificateExtra CertificateExtra 证书扩展信息。
注意：此字段可能返回 null，表示取不到有效值。
DvAuthDetail DvAuthDetail DV 认证信息。
注意：此字段可能返回 null，表示取不到有效值。
VulnerabilityReport String 漏洞扫描评估报告。
注意：此字段可能返回 null，表示取不到有效值。
示例值：no problem
CertificateId String 证书 ID。
注意：此字段可能返回 null，表示取不到有效值。
示例值：heysh**he
PackageTypeName String 证书类型名称。
注意：此字段可能返回 null，表示取不到有效值。
示例值：TrustAsia C1 DV Free
StatusName String 状态描述。
注意：此字段可能返回 null，表示取不到有效值。
示例值：已颁发
SubjectAltName Array of String 证书包含的多个域名（包含主域名）。
注意：此字段可能返回 null，表示取不到有效值。
示例值：["www.****.online"]
IsVip Boolean 是否为 VIP 客户。
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
IsWildcard Boolean 是否为泛域名证书。
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
IsDv Boolean 是否为 DV 版证书。
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
IsVulnerability Boolean 是否启用了漏洞扫描功能。
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
RenewAble Boolean 是否可重颁发证书。
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
SubmittedData SubmittedData 提交的资料信息。
注意：此字段可能返回 null，表示取不到有效值。
Deployable Boolean 是否可部署。
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
Tags Array of Tags 标签列表
注意：此字段可能返回 null，表示取不到有效值。
CAEncryptAlgorithms Array of String CA证书的所有加密方式。仅证书类型CertificateType为CA有效
注意：此字段可能返回 null，表示取不到有效值。
示例值：["RSA"]
CACommonNames Array of String CA证书的所有通用名称。仅证书类型CertificateType为CA有效
注意：此字段可能返回 null，表示取不到有效值。
示例值：["TrustAsia C1 DV Free"]
CAEndTimes Array of String CA证书所有的到期时间。仅证书类型CertificateType为CA有效
注意：此字段可能返回 null，表示取不到有效值。
示例值：["2024-11-27 17:44:36"]
DvRevokeAuthDetail Array of DvAuths DV证书吊销验证值
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取证书信息

获取证书信息

输入示例

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

{
    "CertificateId": "hhe**jjsj"
}

输出示例

{
    "Response": {
        "OwnerUin": "100017***920",
        "ProjectId": "0",
        "From": "trustasia",
        "CertificateType": "SVR",
        "PackageType": "83",
        "ProductZhName": "TrustAsia C1 DV Free",
        "Domain": "zrhh.online",
        "Alias": "",
        "Status": 1,
        "StatusMsg": "CA-REVIEWING",
        "VerifyType": "DNS_AUTO",
        "VulnerabilityStatus": "INACTIVE",
        "CertBeginTime": "2024-11-27 08:00:00",
        "CertEndTime": "2025-02-26 07:59:59",
        "ValidityPeriod": "3",
        "InsertTime": "2024-11-27 17:44:36",
        "OrderId": "Hy***85G_mZOLxSuw",
        "DvAuthDetail": {
            "DvAuths": null,
            "DvAuthKey": null,
            "DvAuthValue": null,
            "DvAuthDomain": null,
            "DvAuthPath": null,
            "DvAuthKeySubDomain": ""
        },
        "VulnerabilityReport": null,
        "CertificateId": "Juz8JAxn",
        "StatusName": "已颁发",
        "SubjectAltName": [
            "www.zrhh.online"
        ],
        "IsVip": false,
        "IsWildcard": false,
        "IsDv": true,
        "IsVulnerability": false,
        "RenewAble": false,
        "SubmittedData": null,
        "Deployable": true,
        "Tags": [],
        "CAEncryptAlgorithms": [],
        "CACommonNames": [],
        "CAEndTimes": [],
        "DvRevokeAuthDetail": [],
        "CertificateExtra": {
            "SMCert": 0,
            "ReplacedBy": null,
            "OriginCertificateId": null,
            "ReplacedFor": null,
            "RenewOrder": null,
            "DomainNumber": "1",
            "CompanyType": 1
        },
        "PackageTypeName": "TrustAsia C1 DV Free",
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

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.NetworkError 当前 CA 机构访问繁忙，请稍后重试。
FailedOperation.NoProjectPermission 您没有该项目的操作权限。
FailedOperation.NoRealNameAuth 尚未通过实名认证。
FailedOperation.OrderAlreadyReplaced 该订单已重签发。
FailedOperation.OrderReplaceFailed 重颁发失败。
InternalError 内部错误。
LimitExceeded.RateLimitExceeded 单位时间内接口请求频率达到限制。
中国站
文档活动
message-icon联系我们
目录