1. 接口描述
接口请求域名： ssl.tencentcloudapi.com 。
本接口（DescribeCertificates）用于获取证书列表。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCertificates。 |
| Version | 是 | String | 公共参数，本接口取值：2019-12-05。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Offset | 否 | Integer | 分页偏移量，从0开始。 默认为0 示例值：0 |
| Limit | 否 | Integer | 每页数量，默认10。最大值1000，如超过1000按1000处理 示例值：11 |
| SearchKey | 否 | String | 搜索关键词，模糊匹配证书 ID、备注名称、证书域名 示例值：string |
| CertificateType | 否 | String | 证书类型：CA = 客户端证书，SVR = 服务器证书。 示例值：CA |
| ProjectId | 否 | Integer | 项目 ID。 示例值：1 |
| ExpirationSort | 否 | String | 默认按照证书申请时间降序； 若传排序则按到期时间排序：DESC = 证书到期时间降序， ASC = 证书到期时间升序。 示例值：DESC |
| CertificateStatus.N | 否 | Array of Integer | 证书状态：0 = 审核中，1 = 已通过，2 = 审核失败，3 = 已过期，4 = 已添加DNS记录，5 = 企业证书，待提交，6 = 订单取消中，7 = 已取消，8 = 已提交资料， 待上传确认函，9 = 证书吊销中，10 = 已吊销，11 = 重颁发中，12 = 待上传吊销确认函，13 = 免费证书待提交资料。14 = 已退款。 15 = 证书迁移中 示例值：[1] |
| Deployable | 否 | Integer | 是否可部署，可选值：1 = 可部署，0 = 不可部署。 示例值：1 |
| Upload | 否 | Integer | 是否筛选上传托管的 1筛选，0不筛选 示例值：1 |
| Renew | 否 | Integer | 是否筛选可续期证书 1筛选 0不筛选 示例值：1 |
| FilterSource | 否 | String | 筛选来源， upload：上传证书， buy：腾讯云证书， 不传默认全部 示例值：upload |
| IsSM | 否 | Integer | 是否筛选国密证书。1:筛选 0:不筛选 示例值：1 |
| FilterExpiring | 否 | Integer | 筛选证书是否即将过期，传1是筛选，0不筛选 示例值：0 |
| Hostable | 否 | Integer | 是否可托管，可选值：1 = 可托管，0 = 不可托管。 示例值：1 |
| Tags.N | 否 | Array of Tags | 筛选指定标签的证书 |
| IsPendingIssue | 否 | Integer | 是否筛选等待签发的证书，传1是筛选，0和null不筛选 示例值：1 |
| CertIds.N | 否 | Array of String | 筛选指定证书ID的证书，只支持有权限的证书ID 示例值：["FxG06njc"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数量。 示例值：10 |
| Certificates | Array of Certificates | 列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取证书列表
获取证书列表
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<公共请求参数>
{
"Limit": 1,
"Offset": 0
}输出示例
{
"Response": {
"TotalCount": 1,
"Certificates": [
{
"OwnerUin": "10*******",
"ProjectId": "zr*****",
"From": "upload",
"PackageType": "company",
"CertificateType": "svr",
"ProductZhName": "DigiCert Secure Site CN CA G3",
"Domain": "www.zrh.com",
"Alias": "upload cert",
"Status": 1,
"CertificateExtra": {
"DomainNumber": "10983",
"OriginCertificateId": "hj****",
"ReplacedBy": "hkk****",
"ReplacedFor": "ete****",
"RenewOrder": "feg****",
"SMCert": 0,
"CompanyType": 0
},
"VulnerabilityStatus": "INACTIVE",
"StatusMsg": "PRE-REVIEWING",
"VerifyType": "DNS",
"CertBeginTime": "2024-11-06 08:00:0",
"CertEndTime": "2025-12-02 07:59:59",
"ValidityPeriod": "13",
"InsertTime": "2024-11-11 11:53:07",
"CertificateId": "hdhd**",
"SubjectAltName": [
"zrh"
],
"PackageTypeName": "company",
"StatusName": "证书已颁发",
"IsVip": true,
"IsDv": true,
"IsWildcard": true,
"IsVulnerability": true,
"RenewAble": true,
"ProjectInfo": {
"ProjectName": "默认项目",
"ProjectCreatorUin": 1,
"ProjectCreateTime": "0000-00-00 00:00:00",
"ProjectResume": "默认项目",
"OwnerUin": 1,
"ProjectId": "0"
},
"BoundResource": [
""
],
"Deployable": true,
"Tags": [
{
"TagKey": "zrh",
"TagValue": "ok"
}
],
"IsIgnore": true,
"IsSM": true,
"EncryptAlgorithm": "svr",
"CAEncryptAlgorithms": [
"svr"
],
"CAEndTimes": [],
"CACommonNames": [],
"PreAuditInfo": {
"TotalPeriod": 0,
"NowPeriod": 0,
"ManagerId": "84994"
},
"AutoRenewFlag": 0,
"HostingStatus": 0,
"HostingCompleteTime": "2024-11-06 08:00:00",
"HostingRenewCertId": "2024-11-06 08:00:00",
"HasRenewOrder": "yes",
"ReplaceOriCertIsDelete": true,
"IsExpiring": true,
"DVAuthDeadline": "2024-11-06 08:00:00",
"ValidationPassedTime": "2024-11-06 08:00:00",
"CertSANs": [
"normal"
],
"AwaitingValidationMsg": "wait",
"AllowDownload": true,
"IsDNSPODResolve": true,
"IsPackage": true,
"KeyPasswordCustomFlag": true,
"SupportDownloadType": {
"NGINX": true,
"APACHE": true,
"TOMCAT": true,
"IIS": true,
"JKS": true,
"OTHER": true,
"ROOT": true
},
"IsHostingUploadRenewCert": false
}
],
"RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
}
}示例2 获取证书列表 - SearchKey查询域名
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<公共请求参数>
{
"Offset": "0",
"Limit": "1",
"SearchKey": "ninghhuang"
}输出示例
{
"Response": {
"TotalCount": 54,
"Certificates": [
{
"OwnerUin": "815836472",
"ProjectId": "0",
"From": "trustasia",
"ProductZhName": "TrustAsia C1 DV Free",
"Domain": "ninghhuang.online",
"Alias": "",
"Status": 1,
"VulnerabilityStatus": "INACTIVE",
"StatusMsg": "ca-reviewing",
"VerifyType": "DNS_AUTO",
"CertBeginTime": "2025-02-12 08:00:00",
"CertEndTime": "2025-05-14 07:59:59",
"ValidityPeriod": "3",
"InsertTime": "2025-02-12 10:11:21",
"AutoRenewFlag": 1,
"EncryptAlgorithm": "RSA 2048",
"IsIgnore": false,
"PreAuditInfo": {
"TotalPeriod": 1,
"NowPeriod": 1,
"ManagerId": ""
},
"IsSM": false,
"SubjectAltName": [
"ninghhuang.online",
"www.ninghhuang.online"
],
"StatusName": "证书已颁发",
"IsVip": false,
"IsDv": true,
"IsWildcard": false,
"IsVulnerability": false,
"HasRenewOrder": "",
"ReplaceOriCertIsDelete": false,
"RenewAble": false,
"IsExpiring": false,
"DVAuthDeadline": "2025-02-19 10:11:21",
"ValidationPassedTime": "--",
"CertSANs": [
"ninghhuang.online",
"www.ninghhuang.online"
],
"CertRevokedTime": "",
"CAEncryptAlgorithms": [],
"CAEndTimes": [],
"CACommonNames": [],
"Deployable": true,
"AwaitingValidationMsg": "",
"ProjectInfo": {
"ProjectId": "0",
"OwnerUin": 0,
"ProjectName": "默认项目",
"ProjectCreatorUin": 0,
"ProjectCreateTime": "0000-00-00 00:00:00",
"ProjectResume": "默认项目"
},
"Tags": [],
"CertificateId": "LtIaSxlb",
"CertificateType": "SVR",
"PackageType": "83",
"PackageTypeName": "TrustAsia C1 DV Free",
"KeyPasswordCustomFlag": false,
"SupportDownloadType": {
"NGINX": true,
"APACHE": true,
"TOMCAT": true,
"IIS": true,
"JKS": true,
"OTHER": true,
"ROOT": true
},
"CertificateExtra": {
"DomainNumber": "1",
"OriginCertificateId": null,
"ReplacedBy": null,
"ReplacedFor": null,
"RenewOrder": null,
"SMCert": 0,
"CompanyType": 1
},
"AllowDownload": false,
"IsPackage": false,
"HostingStatus": -1,
"HostingCompleteTime": "",
"HostingRenewCertId": "",
"HostingResourceTypes": [],
"IsDNSPODResolve": false,
"IsHostingUploadRenewCert": false,
"BoundResource": []
}
],
"RequestId": "e7f6021f-47bb-476b-a424-6a0cde19a1eb"
}
}示例3 获取证书列表 - SearchKey查询证书ID
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<公共请求参数>
{
"Offset": "0",
"Limit": "1",
"SearchKey": "LtIaS"
}输出示例
{
"Response": {
"TotalCount": 1,
"Certificates": [
{
"OwnerUin": "815836472",
"ProjectId": "0",
"From": "trustasia",
"ProductZhName": "TrustAsia C1 DV Free",
"Domain": "ninghhuang.online",
"Alias": "",
"Status": 1,
"VulnerabilityStatus": "INACTIVE",
"StatusMsg": "",
"VerifyType": "DNS_AUTO",
"CertBeginTime": "2025-02-12 08:00:00",
"CertEndTime": "2025-05-14 07:59:59",
"ValidityPeriod": "3",
"InsertTime": "2025-02-12 10:11:21",
"AutoRenewFlag": 1,
"EncryptAlgorithm": "RSA 2048",
"IsIgnore": false,
"PreAuditInfo": {
"TotalPeriod": 1,
"NowPeriod": 1,
"ManagerId": ""
},
"IsSM": false,
"SubjectAltName": [
"ninghhuang.online",
"www.ninghhuang.online"
],
"StatusName": "证书已颁发",
"IsVip": false,
"IsDv": true,
"IsWildcard": false,
"IsVulnerability": false,
"HasRenewOrder": "",
"ReplaceOriCertIsDelete": false,
"RenewAble": false,
"IsExpiring": false,
"DVAuthDeadline": "2025-02-19 10:11:21",
"ValidationPassedTime": "--",
"CertSANs": [
"ninghhuang.online",
"www.ninghhuang.online"
],
"CertRevokedTime": "",
"CAEncryptAlgorithms": [],
"CAEndTimes": [],
"CACommonNames": [],
"Deployable": true,
"AwaitingValidationMsg": "",
"ProjectInfo": {
"ProjectId": "0",
"OwnerUin": 0,
"ProjectName": "默认项目",
"ProjectCreatorUin": 0,
"ProjectCreateTime": "0000-00-00 00:00:00",
"ProjectResume": "默认项目"
},
"Tags": [],
"CertificateId": "LtIaSxlb",
"CertificateType": "SVR",
"PackageType": "83",
"PackageTypeName": "TrustAsia C1 DV Free",
"KeyPasswordCustomFlag": false,
"SupportDownloadType": {
"NGINX": true,
"APACHE": true,
"TOMCAT": true,
"IIS": true,
"JKS": true,
"OTHER": true,
"ROOT": true
},
"CertificateExtra": {
"DomainNumber": "1",
"OriginCertificateId": null,
"ReplacedBy": null,
"ReplacedFor": null,
"RenewOrder": null,
"SMCert": 0,
"CompanyType": 1
},
"AllowDownload": false,
"IsPackage": false,
"HostingStatus": -1,
"HostingCompleteTime": "",
"HostingRenewCertId": "",
"HostingResourceTypes": [],
"IsDNSPODResolve": false,
"IsHostingUploadRenewCert": false,
"BoundResource": []
}
],
"RequestId": "e7f6021f-47bb-476b-a424-6a0cde19a1eb"
}
}示例4 获取证书列表 - SearchKey查询备注名称
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<公共请求参数>
{
"Offset": "0",
"Limit": "1",
"SearchKey": "K926htp2"
}输出示例
{
"Response": {
"TotalCount": 2,
"Certificates": [
{
"OwnerUin": "815836472",
"ProjectId": "0",
"From": "trustasia",
"ProductZhName": "TrustAsia C1 DV Free",
"Domain": "ninghhuang.online",
"Alias": "K926htp2的自动续费证书",
"Status": 1,
"VulnerabilityStatus": "INACTIVE",
"StatusMsg": "",
"VerifyType": "DNS_AUTO",
"CertBeginTime": "2025-02-05 08:00:00",
"CertEndTime": "2025-05-07 07:59:59",
"ValidityPeriod": "3",
"InsertTime": "2025-02-05 08:26:42",
"AutoRenewFlag": 1,
"EncryptAlgorithm": "RSA 2048",
"IsIgnore": false,
"PreAuditInfo": {
"TotalPeriod": 1,
"NowPeriod": 1,
"ManagerId": ""
},
"IsSM": false,
"SubjectAltName": [
"ninghhuang.online",
"www.ninghhuang.online"
],
"StatusName": "证书已颁发",
"IsVip": false,
"IsDv": true,
"IsWildcard": false,
"IsVulnerability": false,
"HasRenewOrder": "",
"ReplaceOriCertIsDelete": false,
"RenewAble": false,
"IsExpiring": false,
"DVAuthDeadline": "2025-02-12 08:26:42",
"ValidationPassedTime": "--",
"CertSANs": [
"ninghhuang.online",
"www.ninghhuang.online"
],
"CertRevokedTime": "",
"CAEncryptAlgorithms": [],
"CAEndTimes": [],
"CACommonNames": [],
"Deployable": true,
"AwaitingValidationMsg": "",
"ProjectInfo": {
"ProjectId": "0",
"OwnerUin": 0,
"ProjectName": "默认项目",
"ProjectCreatorUin": 0,
"ProjectCreateTime": "0000-00-00 00:00:00",
"ProjectResume": "默认项目"
},
"Tags": [],
"CertificateId": "Li1AKHnS",
"CertificateType": "SVR",
"PackageType": "83",
"PackageTypeName": "TrustAsia C1 DV Free",
"KeyPasswordCustomFlag": false,
"SupportDownloadType": {
"NGINX": true,
"APACHE": true,
"TOMCAT": true,
"IIS": true,
"JKS": true,
"OTHER": true,
"ROOT": true
},
"CertificateExtra": {
"DomainNumber": "1",
"OriginCertificateId": "K926htp2",
"ReplacedBy": null,
"ReplacedFor": null,
"RenewOrder": null,
"SMCert": 0,
"CompanyType": 1
},
"AllowDownload": false,
"IsPackage": false,
"HostingStatus": 0,
"HostingCompleteTime": "2025-02-05 08:39:30",
"HostingRenewCertId": "",
"HostingResourceTypes": [
"cdn",
"clb",
"cos"
],
"HostingConfig": {
"MessageTypes": [
0
],
"ReplaceEndTime": "23:59:59",
"ReplaceStartTime": "00:00:00",
"ReplaceTime": 999
},
"IsDNSPODResolve": false,
"IsHostingUploadRenewCert": false,
"BoundResource": []
}
],
"RequestId": "e7f6021f-47bb-476b-a424-6a0cde19a1eb"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.AuthError | 请检查是否有权限。 |
| FailedOperation.CAMAuthorizedFail | CAM鉴权出现错误。 |
| 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 | 重颁发失败。 |
| FailedOperation.SystemError | 系统错误。 |
| InternalError | 内部错误。 |
| InternalError.BackendResponseEmpty | 后端服务响应为空。 |
| LimitExceeded.RateLimitExceeded | 单位时间内接口请求频率达到限制。 |
