SSL 证书获取证书详情-API 文档-文档中心-腾讯云

1. 接口描述

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

获取证书详情。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
OwnerUin	String	证书所属用户主账号 UIN。注意：此字段可能返回 null，表示取不到有效值。示例值：818****6472
ProjectId	String	项目 ID。注意：此字段可能返回 null，表示取不到有效值。示例值：0
From	String	证书来源： trustasia：亚洲诚信， upload：用户上传。 wosign：沃通 sheca：上海CA 注意：此字段可能返回 null，表示取不到有效值。示例值：trustasia
CertificateType	String	证书类型：CA = 客户端证书，SVR = 服务器证书。注意：此字段可能返回 null，表示取不到有效值。示例值：SVR
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，表示取不到有效值。示例值：83
ProductZhName	String	证书产品名称注意：此字段可能返回 null，表示取不到有效值。示例值：TrustAsia C1 DV Free
Domain	String	证书绑定通用名称域名。注意：此字段可能返回 null，表示取不到有效值。示例值：nin*ang.online
Alias	String	备注名称。注意：此字段可能返回 null，表示取不到有效值。示例值：helllo
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 = 文件验证，EMAIL = 邮件验证。注意：此字段可能返回 null，表示取不到有效值。示例值：DNS
VulnerabilityStatus	String	漏洞扫描状态。注意：此字段可能返回 null，表示取不到有效值。示例值：INACTIVE
CertBeginTime	Timestamp	证书生效时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2024-12-03 08:00:00
CertEndTime	Timestamp	证书失效时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2025-01-03 07:59:59
ValidityPeriod	String	证书有效期：单位（月）。注意：此字段可能返回 null，表示取不到有效值。示例值：3
InsertTime	Timestamp	证书申请时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2024-12-03 19:38:47
OrderId	String	CA订单 ID。注意：此字段可能返回 null，表示取不到有效值。示例值：hehys****jsj
CertificateExtra	CertificateExtra	证书扩展信息。注意：此字段可能返回 null，表示取不到有效值。
CertificatePrivateKey	String	私钥证书，国密证书则为签名证书中的私钥证书注意：此字段可能返回 null，表示取不到有效值。示例值：-----BEGIN RSA PRIVATE KEY----***
CertificatePublicKey	String	公钥证书，国密则为签名证书中的公钥证书注意：此字段可能返回 null，表示取不到有效值。示例值：-----BEGIN CERTIFICATE-----***
DvAuthDetail	DvAuthDetail	证书域名验证信息。注意：此字段可能返回 null，表示取不到有效值。
VulnerabilityReport	String	漏洞扫描评估报告。注意：此字段可能返回 null，表示取不到有效值。示例值：no problem
CertificateId	String	证书 ID。注意：此字段可能返回 null，表示取不到有效值。示例值：hehys****hhe
TypeName	String	证书类型名称。注意：此字段可能返回 null，表示取不到有效值。示例值：TrustAsia C1 DV Free
StatusName	String	状态描述。注意：此字段可能返回 null，表示取不到有效值。示例值：已颁发
SubjectAltName	Array of String	证书包含的多个域名（不包含主域名，主域名使用Domain字段）注意：此字段可能返回 null，表示取不到有效值。示例值：["www.ninghhuang.online"]
IsVip	Boolean	是否为付费证书。注意：此字段可能返回 null，表示取不到有效值。示例值：true
IsWildcard	Boolean	是否为泛域名证书。注意：此字段可能返回 null，表示取不到有效值。示例值：false
IsDv	Boolean	是否为 DV 版证书。注意：此字段可能返回 null，表示取不到有效值。示例值：true
IsVulnerability	Boolean	是否启用了漏洞扫描功能。注意：此字段可能返回 null，表示取不到有效值。示例值：true
SubmittedData	SubmittedData	付费证书提交的资料信息。注意：此字段可能返回 null，表示取不到有效值。
RenewAble	Boolean	是否可续费。注意：此字段可能返回 null，表示取不到有效值。示例值：true
Deployable	Boolean	是否可部署。注意：此字段可能返回 null，表示取不到有效值。示例值：true
Tags	Array of Tags	关联标签列表。注意：此字段可能返回 null，表示取不到有效值。
RootCert	RootCertificates	根证书。注意：此字段可能返回 null，表示取不到有效值。
EncryptCert	String	国密加密证书公钥，仅国密证书有值注意：此字段可能返回 null，表示取不到有效值。示例值：-----BEGIN CERTIFICATE-
EncryptPrivateKey	String	国密加密私钥证书，仅国密证书有值注意：此字段可能返回 null，表示取不到有效值。示例值：----BEGIN RSA PRIVATE KEY----***
CertFingerprint	String	签名证书 SHA1指纹注意：此字段可能返回 null，表示取不到有效值。示例值：5894DA009D7B378A96D168A56B1EC4E2D8065A8D
EncryptCertFingerprint	String	加密证书 SHA1指纹（国密证书特有）注意：此字段可能返回 null，表示取不到有效值。示例值：5894DA009D7B378A96D168A56
EncryptAlgorithm	String	证书加密算法（国密证书特有）注意：此字段可能返回 null，表示取不到有效值。示例值：RSA 2048
DvRevokeAuthDetail	Array of DvAuths	DV证书吊销验证值注意：此字段可能返回 null，表示取不到有效值。
CertChainInfo	Array of CertBasicInfo	证书链信息注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取证书详情

获取审核中的证书详情

输入示例

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

{
    "CertificateId": "aClRkC90"
}

输出示例

{
    "Response": {
        "OwnerUin": "815836472",
        "ProjectId": "0",
        "From": "trustasia",
        "OrderId": "u1hD8*****mXue",
        "CertificateType": "SVR",
        "PackageType": "48",
        "ProductZhName": "DNSPod-域名型(DV)SSL证书",
        "Domain": "ninghhuang.online",
        "Alias": "",
        "Status": 4,
        "StatusMsg": "CA-REVIEWING",
        "VulnerabilityStatus": "INACTIVE",
        "RootCert": {
            "Sign": null,
            "Encrypt": null,
            "Standard": null
        },
        "EncryptCert": null,
        "EncryptPrivateKey": null,
        "CertificatePrivateKey": "*******",
        "CertificatePublicKey": null,
        "CertBeginTime": null,
        "CertEndTime": null,
        "ValidityPeriod": "12",
        "InsertTime": "2024-12-02 19:12:46",
        "VulnerabilityReport": null,
        "CertificateId": "K33dxkOk",
        "TypeName": "DNSPod-域名型(DV)SSL证书",
        "StatusName": "待验证",
        "CertificateExtra": {
            "SMCert": 0,
            "ReplacedBy": null,
            "OriginCertificateId": null,
            "ReplacedFor": null,
            "RenewOrder": null,
            "DomainNumber": "1",
            "CompanyType": 2
        },
        "DvAuthDetail": {
            "DvAuths": [
                {
                    "DvAuthKey": "_875bed25cf9e03596931d91cb0a52bd9.ninghhuang.online",
                    "DvAuthValue": "a3108492878a2d989949fa50522dd2b0.cc7346307ff022fcfa68e025f6dbf6ad.cmcdpcwca5iljv.trust-provider.com",
                    "DvAuthDomain": "ninghhuang.online",
                    "DvAuthPath": null,
                    "DvAuthSubDomain": "_875bed25cf9e03596931d91cb0a52bd9",
                    "DvAuthVerifyType": "CNAME"
                }
            ],
            "DvAuthKey": "_875bed25cf9e03596931d91cb0a52bd9.ninghhuang.online",
            "DvAuthValue": "a3108492878a2d989949fa50522dd2b0.cc7346307ff022fcfa68e025f6dbf6ad.cmcdpcwca5iljv.trust-provider.com",
            "DvAuthDomain": "ni****ang.online",
            "DvAuthPath": null,
            "DvAuthKeySubDomain": "_875bed25cf9e03596931d91cb0a52bd9"
        },
        "VerifyType": "DNS_AUTO",
        "DvRevokeAuthDetail": [],
        "SubjectAltName": [],
        "IsVip": true,
        "IsWildcard": false,
        "IsDv": true,
        "IsVulnerability": false,
        "SubmittedData": null,
        "RenewAble": false,
        "Deployable": true,
        "Tags": [],
        "CertFingerprint": null,
        "EncryptCertFingerprint": null,
        "EncryptAlgorithm": "RSA 2048",
        "CertChainInfo": null,
        "RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
    }
}

示例2 获取证书详情-2

获取已经审核通过的证书详情

输入示例

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

{
    "CertificateId": "aCMEQWHt"
}

输出示例

{
    "Response": {
        "OwnerUin": "815836472",
        "ProjectId": "0",
        "From": "trustasia",
        "OrderId": "PVpvxIN2_E*****pvjw",
        "CertificateType": "SVR",
        "PackageType": "43",
        "ProductZhName": "DNSPod-企业型(OV)SSL证书",
        "Domain": "ninghhuang.online",
        "Alias": "",
        "Status": 4,
        "StatusMsg": "PRE-REVIEWING",
        "VulnerabilityStatus": "INACTIVE",
        "RootCert": {
            "Sign": null,
            "Encrypt": null,
            "Standard": null
        },
        "EncryptCert": null,
        "EncryptPrivateKey": null,
        "CertificatePrivateKey": "*****",
        "CertificatePublicKey": null,
        "CertBeginTime": null,
        "CertEndTime": null,
        "ValidityPeriod": "12",
        "InsertTime": "2024-11-27 20:06:51",
        "VulnerabilityReport": null,
        "CertificateId": "Jv8u7beI",
        "TypeName": "DNSPod-企业型(OV)SSL证书",
        "StatusName": "待验证",
        "CertificateExtra": {
            "SMCert": 0,
            "ReplacedBy": null,
            "OriginCertificateId": null,
            "ReplacedFor": null,
            "RenewOrder": null,
            "DomainNumber": "1",
            "CompanyType": 2
        },
        "DvAuthDetail": {
            "DvAuths": [
                {
                    "DvAuthKey": "_882a77cde28ffe49e5764ab3afb75849.ninghhuang.online",
                    "DvAuthValue": "97f80ec4c7947178cec6b5a093ed34b0.a5cd7986aaaffdfd37437c9c6de1dd30.cmcopc2ncmbffy.trust-provider.com",
                    "DvAuthDomain": "ninghhuang.online",
                    "DvAuthPath": null,
                    "DvAuthSubDomain": "_882a77cde28ffe49e5764ab3afb75849",
                    "DvAuthVerifyType": "CNAME"
                }
            ],
            "DvAuthKey": "_882a77cde28ffe49e5764ab3afb75849.ninghhuang.online",
            "DvAuthValue": "97f80ec4c7947178cec6b5a093ed34b0.a5cd7986aaaffdfd37437c9c6de1dd30.cmcopc2ncmbffy.trust-provider.com",
            "DvAuthDomain": "ninghhuang.online",
            "DvAuthPath": null,
            "DvAuthKeySubDomain": "_882a77cde28ffe49e5764ab3afb75849"
        },
        "VerifyType": "DNS_AUTO",
        "DvRevokeAuthDetail": [],
        "SubjectAltName": [],
        "IsVip": true,
        "IsWildcard": false,
        "IsDv": false,
        "IsVulnerability": false,
        "SubmittedData": null,
        "RenewAble": false,
        "Deployable": true,
        "Tags": [],
        "CertFingerprint": null,
        "EncryptCertFingerprint": null,
        "EncryptAlgorithm": "RSA 2048",
        "CertChainInfo": null,
        "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。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.AuthError	请检查是否有权限。
FailedOperation.CannotGetOrder	获取订单信息失败，请稍后重试。
FailedOperation.CertificateInvalid	证书不符合标准。
FailedOperation.CertificateNotFound	证书不存在。
FailedOperation.InvalidParam	参数有误。
FailedOperation.NoProjectPermission	您没有该项目的操作权限。
FailedOperation.NoRealNameAuth	尚未通过实名认证。
InternalError	内部错误。
InternalError.BackendResponseEmpty	后端服务响应为空。
LimitExceeded.RateLimitExceeded	单位时间内接口请求频率达到限制。
ResourceNotFound.Manager	公司管理人不存在。

获取证书详情

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 获取证书详情

输入示例

输出示例

示例2 获取证书详情-2

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码