1. 接口描述
本接口（DescribeCertificates）用于获取证书列表。接口请求域名： ssl.tencentcloudapi.com 。
默认接口请求频率限制：5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCertificates。 |
| Version | 是 | String | 公共参数，本接口取值：2019-12-05。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Offset | 否 | Integer | 分页偏移量，从0开始。 |
| Limit | 否 | Integer | 每页数量，默认20。最大1000 |
| SearchKey | 否 | String | 搜索关键词，可搜索证书 ID、备注名称、域名。例如： a8xHcaIs。 |
| CertificateType | 否 | String | 证书类型：CA = 客户端证书，SVR = 服务器证书。 |
| ProjectId | 否 | Integer | 项目 ID。 |
| ExpirationSort | 否 | String | 按到期时间排序：DESC = 降序， ASC = 升序。 |
| CertificateStatus.N | 否 | Array of Integer | 证书状态：0 = 审核中，1 = 已通过，2 = 审核失败，3 = 已过期，4 = 已添加DNS记录，5 = 企业证书，待提交，6 = 订单取消中，7 = 已取消，8 = 已提交资料， 待上传确认函，9 = 证书吊销中，10 = 已吊销，11 = 重颁发中，12 = 待上传吊销确认函，13 = 免费证书待提交资料。 |
| Deployable | 否 | Integer | 是否可部署，可选值：1 = 可部署，0 = 不可部署。 |
| Upload | 否 | Integer | 是否筛选上传托管的 1筛选，0不筛选 |
| Renew | 否 | Integer | 是否筛选可续期证书 1筛选 0不筛选 |
| FilterSource | 否 | String | 筛选来源， upload：上传证书， buy：腾讯云证书， 不传默认全部 |
| IsSM | 否 | Integer | 是否筛选国密证书。1:筛选 0:不筛选 |
| FilterExpiring | 否 | Integer | 筛选证书是否即将过期，传1是筛选，0不筛选 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数量。 注意：此字段可能返回 null，表示取不到有效值。 |
| Certificates | Array of Certificates | 列表。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取证书列表
获取证书列表
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<公共请求参数>
{
"Limit": "1"
}输出示例
{
"Response": {
"Certificates": [
{
"From": "trustasia",
"SubjectAltName": null,
"BoundResource": [],
"CertificateExtra": {
"OriginCertificateId": null,
"ReplacedBy": null,
"ReplacedFor": "a8xHcaIs",
"DomainNumber": null,
"RenewOrder": null
},
"StatusName": "已通过",
"RenewAble": false,
"Status": 1,
"IsDv": true,
"CertBeginTime": "2020-01-14 16:00:00",
"IsVulnerability": false,
"VerifyType": "DNS",
"StatusMsg": null,
"ProjectId": "0",
"OwnerUin": "20548499",
"ProjectInfo": {
"ProjectCreatorUin": 0,
"ProjectCreateTime": "0000-00-00 00:00:00",
"ProjectId": "0",
"OwnerUin": 0,
"ProjectResume": "默认项目",
"ProjectName": "默认项目"
},
"ProductZhName": "TrustAsia TLS RSA CA",
"CertEndTime": "2020-02-12 16:00:00",
"PackageType": "2",
"InsertTime": "2020-01-14 10:54:47",
"CertificateType": "SVR",
"IsVip": false,
"ValidityPeriod": "0",
"Domain": "wgc.red",
"CertificateId": "a90XEOtj",
"Alias": "a8xHcaIs的重颁发订单",
"IsWildcard": false,
"PackageTypeName": "TrustAsia TLS RSA CA",
"VulnerabilityStatus": "INACTIVE",
"Deployable": true,
"IsIgnore": true,
"IsSM": true,
"EncryptAlgorithm": "RSA 2048",
"CAEncryptAlgorithms": [
"SM2"
],
"CAEndTimes": [
"2022-12-11"
],
"CACommonNames": [
"aasf"
],
"Tags": [
{
"TagKey": "testtag",
"TagValue": "testtag"
},
{
"TagKey": "x",
"TagValue": "testtag"
}
]
}
],
"TotalCount": 12,
"RequestId": "43b82119-c648-4230-8d38-5be63f039549"
}
}示例2 证书列表
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<公共请求参数>
{
"FilterSource": "buy",
"Limit": "1",
"Offset": "0"
}输出示例
{
"Response": {
"TotalCount": 86,
"Certificates": [
{
"OwnerUin": "700000141969",
"ProjectId": "0",
"From": "trustasia",
"PackageType": "12",
"CertificateType": "SVR",
"ProductZhName": "TrustAsia 域名型(DV)通配符",
"Domain": "*.ninghhuang.top",
"Alias": "",
"Status": 1,
"CertificateExtra": null,
"VulnerabilityStatus": "INACTIVE",
"StatusMsg": "",
"VerifyType": "DNS",
"CertBeginTime": "2022-01-12 16:00:00",
"CertEndTime": "2022-05-12 16:00:00",
"ValidityPeriod": "12",
"InsertTime": "2022-01-12 15:39:35",
"PackageTypeName": "TrustAsia 域名型(DV)通配符",
"CertificateId": "su5NDtqX",
"SubjectAltName": null,
"StatusName": "已通过",
"IsVip": true,
"IsDv": true,
"IsWildcard": true,
"IsVulnerability": false,
"RenewAble": false,
"Deployable": true,
"IsIgnore": false,
"IsSM": true,
"EncryptAlgorithm": "ECC 256",
"CAEncryptAlgorithms": [
"SM2"
],
"CAEndTimes": [
"2022-12-11"
],
"CACommonNames": [
"aasf"
],
"ProjectInfo": {
"ProjectId": "0",
"OwnerUin": 0,
"ProjectName": "默认项目",
"ProjectCreatorUin": 0,
"ProjectCreateTime": "0000-00-00 00:00:00",
"ProjectResume": "默认项目"
},
"BoundResource": null,
"Tags": []
}
],
"RequestId": "e398dd3e-68c3-4a7e-be51-bc3db5631a5d"
}
}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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
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 | 重颁发失败。 |
| FailedOperation.SystemError | 系统错误。 |
| InternalError | 内部错误。 |
| LimitExceeded.RateLimitExceeded | 单位时间内接口请求频率达到限制。 |