获取证书信息

最近更新时间:2020-04-28 08:02:30

1. 接口描述

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

本接口(DescribeCertificate)用于获取证书信息。

默认接口请求频率限制:20次/秒。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCertificate。
Version String 公共参数,本接口取值:2019-12-05。
Region String 公共参数,本接口不需要传递此参数。
CertificateId String 证书 ID。

3. 输出参数

参数名称 类型 描述
OwnerUin String 用户 UIN。
注意:此字段可能返回 null,表示取不到有效值。
ProjectId String 项目 ID。
注意:此字段可能返回 null,表示取不到有效值。
From String 证书来源:trustasia = 亚洲诚信,upload = 用户上传。
注意:此字段可能返回 null,表示取不到有效值。
CertificateType String 证书类型:CA = 客户端证书,SVR = 服务器证书。
注意:此字段可能返回 null,表示取不到有效值。
PackageType String 证书套餐类型:1 = GeoTrust DV SSL CA - G3, 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 证书。
注意:此字段可能返回 null,表示取不到有效值。
ProductZhName String 证书办法者名称。
注意:此字段可能返回 null,表示取不到有效值。
Domain String 域名。
注意:此字段可能返回 null,表示取不到有效值。
Alias String 备注名称。
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 证书状态:0 = 审核中,1 = 已通过,2 = 审核失败,3 = 已过期,4 = 已添加DNS记录,5 = 企业证书,待提交,6 = 订单取消中,7 = 已取消,8 = 已提交资料, 待上传确认函,9 = 证书吊销中,10 = 已吊销,11 = 重颁发中,12 = 待上传吊销确认函。
注意:此字段可能返回 null,表示取不到有效值。
StatusMsg String 状态信息。
注意:此字段可能返回 null,表示取不到有效值。
VerifyType String 验证类型:DNS_AUTO = 自动DNS验证,DNS = 手动DNS验证,FILE = 文件验证,EMAIL = 邮件验证。
注意:此字段可能返回 null,表示取不到有效值。
VulnerabilityStatus String 漏洞扫描状态。
注意:此字段可能返回 null,表示取不到有效值。
CertBeginTime String 证书生效时间。
注意:此字段可能返回 null,表示取不到有效值。
CertEndTime String 证书失效时间。
注意:此字段可能返回 null,表示取不到有效值。
ValidityPeriod String 证书有效期:单位(月)。
注意:此字段可能返回 null,表示取不到有效值。
InsertTime String 申请时间。
注意:此字段可能返回 null,表示取不到有效值。
OrderId String 订单 ID。
注意:此字段可能返回 null,表示取不到有效值。
CertificateExtra CertificateExtra 证书扩展信息。
注意:此字段可能返回 null,表示取不到有效值。
DvAuthDetail DvAuthDetail DV 认证信息。
注意:此字段可能返回 null,表示取不到有效值。
VulnerabilityReport String 漏洞扫描评估报告。
注意:此字段可能返回 null,表示取不到有效值。
CertificateId String 证书 ID。
注意:此字段可能返回 null,表示取不到有效值。
PackageTypeName String 证书类型名称。
注意:此字段可能返回 null,表示取不到有效值。
StatusName String 状态描述。
注意:此字段可能返回 null,表示取不到有效值。
SubjectAltName Array of String 证书包含的多个域名(包含主域名)。
注意:此字段可能返回 null,表示取不到有效值。
IsVip Boolean 是否为 VIP 客户。
注意:此字段可能返回 null,表示取不到有效值。
IsWildcard Boolean 是否为泛域名证书。
注意:此字段可能返回 null,表示取不到有效值。
IsDv Boolean 是否为 DV 版证书。
注意:此字段可能返回 null,表示取不到有效值。
IsVulnerability Boolean 是否启用了漏洞扫描功能。
注意:此字段可能返回 null,表示取不到有效值。
RenewAble Boolean 是否可重颁发证书。
注意:此字段可能返回 null,表示取不到有效值。
SubmittedData SubmittedData 提交的资料信息。
注意:此字段可能返回 null,表示取不到有效值。
Deployable Boolean 是否可部署。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取证书信息

输入示例

https://ssl.tencentcloudapi.com/?Action=DescribeCertificate
&CertificateId=CertificateId
&<公共请求参数>

输出示例

{
  "Response": {
    "From": "trustasia",
    "SubjectAltName": null,
    "VulnerabilityReport": null,
    "StatusName": "已通过",
    "CertificateExtra": {
      "OriginCertificateId": null,
      "ReplacedBy": null,
      "ReplacedFor": "a8xHcaIs",
      "DomainNumber": null
    },
    "RenewAble": false,
    "Status": 1,
    "IsDv": true,
    "CertBeginTime": "2020-01-14 16:00:00",
    "IsVulnerability": false,
    "DvAuthDetail": null,
    "VerifyType": "DNS",
    "StatusMsg": null,
    "ProjectId": "0",
    "OwnerUin": "20548499",
    "ProductZhName": "TrustAsia TLS RSA CA",
    "CertEndTime": "2020-02-12 16:00:00",
    "PackageType": "2",
    "RequestId": "6209102a-0f05-411d-a05c-c841431cb636",
    "InsertTime": "2020-01-14 10:54:47",
    "CertificateType": "SVR",
    "IsVip": false,
    "ValidityPeriod": "0",
    "OrderId": "TBD8NHC9J_01",
    "Domain": "wgc.red",
    "CertificateId": "a90XEOtj",
    "Alias": "a8xHcaIs的重颁发订单",
    "SubmittedData": null,
    "IsWildcard": false,
    "PackageTypeName": "TrustAsia TLS RSA CA",
    "VulnerabilityStatus": "INACTIVE"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
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 内部错误。
目录