1. 接口描述
接口请求域名: ssl.tencentcloudapi.com 。
获取证书详情。
默认接口请求频率限制:10次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCertificateDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2019-12-05。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| CertificateId | 是 | String | 证书 ID。 示例值:heysh**he |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| OwnerUin | String | 证书所属用户主账号 UIN。 示例值:818****6472 |
| ProjectId | String | 项目 ID。 示例值:0 |
| From | String | 证书来源: 示例值:trustasia |
| CertificateType | String | 证书类型:CA = 客户端证书,SVR = 服务器证书。 示例值:SVR |
| PackageType | String | 证书套餐类型: 注意:此字段可能返回 null,表示取不到有效值。 示例值:83 |
| ProductZhName | String | 证书产品名称 示例值:TrustAsia C1 DV Free |
| Domain | String | 证书绑定通用名称域名。 示例值:nin*ang.online |
| Alias | String | 备注名称。 示例值:helllo |
| Status | Integer | 证书状态:0 = 审核中,1 = 已通过,2 = 审核失败,3 = 已过期,4 = 自动添加DNS记录,5 = 企业证书,待提交资料,6 = 订单取消中,7 = 已取消,8 = 已提交资料, 待上传确认函,9 = 证书吊销中,10 = 已吊销,11 = 重颁发中,12 = 待上传吊销确认函,13 = 免费证书待提交资料。14 = 证书已退款。 15 = 证书迁移中 示例值:0 |
| StatusMsg | String | 状态信息。 取值范围: 注意:此字段可能返回 null,表示取不到有效值。 示例值:CA-REVIEWING |
| VerifyType | String | 验证类型:DNS_AUTO = 自动DNS验证,DNS = 手动DNS验证,FILE = 文件验证,EMAIL = 邮件验证。 注意:此字段可能返回 null,表示取不到有效值。 示例值:DNS |
| VulnerabilityStatus | String | 漏洞扫描状态。 示例值:INACTIVE |
| CertBeginTime | Timestamp | 证书生效时间。时区为GMT+8:00 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-12-03 08:00:00 |
| CertEndTime | Timestamp | 证书失效时间。时区为GMT+8:00 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-01-03 07:59:59 |
| ValidityPeriod | String | 证书有效期:单位(月)。 示例值:3 |
| InsertTime | Timestamp | 证书申请时间。时区为GMT+8:00 示例值:2024-12-03 19:38:47 |
| OrderId | String | CA订单 ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:hehys****jsj |
| CertificateExtra | CertificateExtra | 证书扩展信息。 |
| CertificatePrivateKey | String | 私钥证书, 国密证书则为签名证书中的私钥证书 注意:此字段可能返回 null,表示取不到有效值。 示例值:-----BEGIN RSA PRIVATE KEY----*** |
| CertificatePublicKey | String | 公钥证书, 国密则为签名证书中的公钥证书 注意:此字段可能返回 null,表示取不到有效值。 示例值:-----BEGIN CERTIFICATE-----*** |
| DvAuthDetail | DvAuthDetail | 证书域名验证信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| VulnerabilityReport | String | 漏洞扫描评估报告。 注意:此字段可能返回 null,表示取不到有效值。 示例值:no problem |
| CertificateId | String | 证书 ID。 示例值:hehys****hhe |
| TypeName | String | 证书类型名称。 注意:此字段可能返回 null,表示取不到有效值。 示例值:TrustAsia C1 DV Free |
| StatusName | String | 状态描述。 示例值:已颁发 |
| SubjectAltName | Array of String | 证书包含的多个域名(不包含主域名,主域名使用Domain字段) 示例值:["www.ninghhuang.online"] |
| IsVip | Boolean | 是否为付费证书。 示例值:true |
| IsWildcard | Boolean | 是否为泛域名证书。 示例值:false |
| IsDv | Boolean | 是否为 DV 版证书。 示例值:true |
| IsVulnerability | Boolean | 是否启用了漏洞扫描功能。 示例值:true |
| SubmittedData | SubmittedData | 付费证书提交的资料信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| RenewAble | Boolean | 是否可续费。 示例值:true |
| Deployable | Boolean | 是否可部署。 示例值:true |
| Tags | Array of Tags | 关联标签列表。 |
| RootCert | RootCertificates | 根证书。 |
| EncryptCert | String | 国密加密证书公钥, 仅国密证书有值 注意:此字段可能返回 null,表示取不到有效值。 示例值:-----BEGIN CERTIFICATE- |
| EncryptPrivateKey | String | 国密加密私钥证书, 仅国密证书有值 注意:此字段可能返回 null,表示取不到有效值。 示例值:----BEGIN RSA PRIVATE KEY----*** |
| CertFingerprint | String | 签名证书 SHA1指纹 注意:此字段可能返回 null,表示取不到有效值。 示例值:5894DA009D7B378A96D168A56B1EC4E2D8065A8D |
| EncryptCertFingerprint | String | 加密证书 SHA1指纹 (国密证书特有) 注意:此字段可能返回 null,表示取不到有效值。 示例值:5894DA009D7B378A96D168A56 |
| EncryptAlgorithm | String | 证书加密算法(国密证书特有) 示例值:RSA 2048 |
| DvRevokeAuthDetail | Array of DvAuths | DV证书吊销验证值 注意:此字段可能返回 null,表示取不到有效值。 |
| CertChainInfo | Array of CertBasicInfo | 证书链信息 注意:此字段可能返回 null,表示取不到有效值。 |
| DomainType | Integer | 证书域名类型, 1(单域名);2(多域名);3(泛域名);4(多泛域名) 示例值:1 |
| CertType | String | 证书类型,DV(域名型);OV(企业型);EV(增强型) 示例值:OV |
| UseCrossSignRoot | Boolean | 是否使用交叉根 示例值:false |
| HostingStatus | Integer | 托管状态,0代表托管中,5代表资源替换中, 10代表托管完成, -1代表未托管 示例值:-1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取证书详情
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificateDetail
<公共请求参数>
{
"CertificateId": "QL*****M"
}
输出示例
{
"Response": {
"OwnerUin": "1000****920",
"ProjectId": "0",
"From": "trustasia",
"OrderId": "xQOzHUgs_Cwm2Vhn0",
"CertificateType": "SVR",
"PackageType": "83",
"ProductZhName": "TrustAsia C1 DV Free",
"Domain": "lukesky.online",
"Alias": "",
"Status": 1,
"StatusMsg": null,
"VulnerabilityStatus": "INACTIVE",
"RootCert": {
"Sign": null,
"Encrypt": null,
"Standard": "-----BEGIN CERTIFICATE-----***********-----END CERTIFICATE-----\n"
},
"EncryptCert": null,
"EncryptPrivateKey": null,
"CertificatePrivateKey": "-----BEGIN RSA PRIVATE KEY-----******-----END RSA PRIVATE KEY-----\r\n",
"CertificatePublicKey": "-----BEGIN CERTIFICATE----*******\n-----END CERTIFICATE-----\n",
"CertBeginTime": "2026-02-28 08:00:00",
"CertEndTime": "2026-05-29 07:59:59",
"ValidityPeriod": "3",
"InsertTime": "2026-02-28 11:23:09",
"VulnerabilityReport": null,
"CertificateId": "QL*****M",
"TypeName": "TrustAsia C1 DV Free",
"StatusName": "已颁发",
"CertificateExtra": {
"SMCert": 0,
"ReplacedBy": null,
"OriginCertificateId": null,
"ReplacedFor": null,
"RenewOrder": null,
"DomainNumber": "1",
"CompanyType": 1
},
"DvAuthDetail": {
"DvAuths": null,
"DvAuthKey": null,
"DvAuthValue": null,
"DvAuthDomain": null,
"DvAuthPath": null,
"DvAuthKeySubDomain": ""
},
"VerifyType": "DNS_AUTO",
"DvRevokeAuthDetail": [],
"SubjectAltName": [
"www.lukesky.online"
],
"IsVip": false,
"IsWildcard": false,
"IsDv": true,
"IsVulnerability": false,
"SubmittedData": null,
"RenewAble": true,
"Deployable": true,
"Tags": [],
"CertFingerprint": "97E056C1BBDDC*******9CCCE112DF8",
"EncryptCertFingerprint": null,
"EncryptAlgorithm": "RSA 2048",
"CertChainInfo": [
{
"Issuer": "TrustAsia DV TLS RSA CA 2025",
"Subject": "lukesky.online",
"Fingerprint": "97e05*************3a89ccce112df8",
"ValidFrom": "2026-02-28 08:00:00",
"ValidTo": "2026-05-29 07:59:59"
},
{
"Issuer": "DigiCert Global Root G2",
"Subject": "TrustAsia DV TLS RSA CA 2025",
"Fingerprint": "7b8a18d***********7c0c634c24994",
"ValidFrom": "2025-01-08 08:00:00",
"ValidTo": "2035-01-08 07:59:59"
}
],
"UseCrossSignRoot": false,
"DomainType": 1,
"CertType": "DV",
"RequestId": "858497b3-d960-4628-9b7c-bbcf96d294e6"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.AuthError | 请检查是否有权限。 |
| FailedOperation.CannotGetOrder | 获取订单信息失败,请稍后重试。 |
| FailedOperation.CertificateCsrParseFailed | CSR解析失败。 |
| FailedOperation.CertificateInvalid | 证书不符合标准。 |
| FailedOperation.CertificateNotFound | 证书不存在。 |
| FailedOperation.InvalidParam | 参数有误。 |
| FailedOperation.NoProjectPermission | 您没有该项目的操作权限。 |
| FailedOperation.NoRealNameAuth | 尚未通过实名认证。 |
| InternalError | 内部错误。 |
| InternalError.BackendResponseEmpty | 后端服务响应为空。 |
| LimitExceeded.RateLimitExceeded | 单位时间内接口请求频率达到限制。 |
| ResourceNotFound.Manager | 公司管理人不存在。 |