1. API Description
Domain name for API request: ssl.intl.tencentcloudapi.com.
This API is used to get the certificate list.
A maximum of 10 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common Params. The value used for this API: DescribeCertificates. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2019-12-05. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| Offset |
No |
Integer |
Pagination offset, starting from 0. default is 0. |
| Limit |
No |
Integer |
Number of items per page. default is 10. maximum value is 1000; values exceeding 1000 will be treated as 1000. |
| SearchKey |
No |
String |
Search keywords, supporting fuzzy match by certificate id, remark name, and certificate domain name. |
| CertificateType |
No |
String |
Certificate type. CA: client certificate; SVR: server certificate |
| ProjectId |
No |
Integer |
Project ID |
| ExpirationSort |
No |
String |
Default sorting is by certificate application time in descending order. Sort by expiration date if the following values are passed: DESC for descending order of certificate expiration time, ASC for ascending order. |
| CertificateStatus.N |
No |
Array of Integer |
Certificate status: 0=under review, 1=approved, 2=review failed, 3=expired, 4=dns record added, 5=enterprise certificate, pending submission, 6=order cancellation in progress, 7=canceled, 8=documents submitted, pending upload of confirmation letter, 9=certificate revocation in progress, 10=revoked, 11=reissue in progress, 12=pending upload of revocation confirmation letter, 13=free certificate pending document submission, 14=refunded, 15=certificate migration in progress. |
| Deployable |
No |
Integer |
Whether the certificate can be deployed. 1: yes; 0: no |
| Upload |
No |
Integer |
Whether to filter uploaded hosted certificates. 1: Yes; 0: No. |
| Renew |
No |
Integer |
Whether to filter renewable certificates. 1: Yes; 0: No. |
| FilterSource |
No |
String |
Filter by source. upload: Uploaded certificate; buy: Tencent Cloud certificate. If this parameter is left empty, all certificates will be queried. |
| IsSM |
No |
Integer |
Whether to filter Chinese SM certificates. 1: Yes; 0: No. |
| FilterExpiring |
No |
Integer |
Whether to filter expiring certificates. 1: Yes; 0: No. |
| Hostable |
No |
Integer |
Whether the certificate can be hosted. Valid values: 1 for yes and 0 for no. |
| Tags.N |
No |
Array of Tags |
Filter certificates with specified tags. |
| IsPendingIssue |
No |
Integer |
Whether to filter certificates pending issue: 1 for filtering, 0 and null for no filtering. |
| CertIds.N |
No |
Array of String |
Filter certificates by the specified certificate id, only supports certificate ids with permission. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TotalCount |
Integer |
Total number
Note: this field may return null, indicating that no valid values can be obtained. |
| Certificates |
Array of Certificates |
List
Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId |
String |
The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Obtain the Certificate List
Obtain the certificate list
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<Common request parameters>
{
"Limit": 1,
"Offset": 0
}
Output Example
{
"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": "Certificate issued"
"IsVip": true,
"IsDv": true,
"IsWildcard": true,
"IsVulnerability": true,
"RenewAble": true,
"ProjectInfo": {
"ProjectName": "Default Project"
"ProjectCreatorUin": 1,
"ProjectCreateTime": "0000-00-00 00:00:00",
"ProjectResume": "Default Project"
"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
}
}
],
"RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
}
}
Example2 Obtain the Certificate List - SearchKey Queries the Domain Name
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<Common request parameters>
{
"Offset": "0",
"Limit": "1",
"SearchKey": "ninghhuang"
}
Output Example
{
"Response": {
"TotalCount": 54,
"Certificates": [
{
"OwnerUin": "815836472",
"ProjectId": "0",
"From": "trustasia",
"ProductZhName": "TrustAsia C1 DV Free",
"Domain": "ninghhuang.online",
"Alias": "",
"Status": 1,
"VulnerabilityStatus": "INACTIVE",
"StatusMsg": null,
"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": "Certificate issued"
"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": null,
"CAEncryptAlgorithms": [],
"CAEndTimes": [],
"CACommonNames": [],
"Deployable": true,
"AwaitingValidationMsg": "",
"ProjectInfo": {
"ProjectId": "0",
"OwnerUin": 0,
"ProjectName": "Default Project"
"ProjectCreatorUin": 0,
"ProjectCreateTime": "0000-00-00 00:00:00",
"ProjectResume": "Default Project"
},
"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": null
},
"AllowDownload": null,
"IsPackage": false,
"HostingStatus": -1,
"HostingCompleteTime": "",
"HostingRenewCertId": "",
"HostingResourceTypes": [],
"HostingConfig": null,
"IsDNSPODResolve": false,
"BoundResource": null
}
],
"RequestId": "e7f6021f-47bb-476b-a424-6a0cde19a1eb"
}
}
Example3 Obtain the Certificate List - SearchKey Queries the Certificate ID
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<Common request parameters>
{
"Offset": "0",
"Limit": "1",
"SearchKey": "LtIaS"
}
Output Example
{
"Response": {
"TotalCount": 1,
"Certificates": [
{
"OwnerUin": "815836472",
"ProjectId": "0",
"From": "trustasia",
"ProductZhName": "TrustAsia C1 DV Free",
"Domain": "ninghhuang.online",
"Alias": "",
"Status": 1,
"VulnerabilityStatus": "INACTIVE",
"StatusMsg": null,
"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": "Certificate issued"
"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": null,
"CAEncryptAlgorithms": [],
"CAEndTimes": [],
"CACommonNames": [],
"Deployable": true,
"AwaitingValidationMsg": "",
"ProjectInfo": {
"ProjectId": "0",
"OwnerUin": 0,
"ProjectName": "Default Project"
"ProjectCreatorUin": 0,
"ProjectCreateTime": "0000-00-00 00:00:00",
"ProjectResume": "Default Project"
},
"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": null
},
"AllowDownload": null,
"IsPackage": false,
"HostingStatus": -1,
"HostingCompleteTime": "",
"HostingRenewCertId": "",
"HostingResourceTypes": [],
"HostingConfig": null,
"IsDNSPODResolve": false,
"BoundResource": null
}
],
"RequestId": "e7f6021f-47bb-476b-a424-6a0cde19a1eb"
}
}
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<Common request parameters>
{
"Offset": "0",
"Limit": "1",
"SearchKey": "K926htp2"
}
Output Example
{
"Response": {
"TotalCount": 2,
"Certificates": [
{
"OwnerUin": "815836472",
"ProjectId": "0",
"From": "trustasia",
"ProductZhName": "TrustAsia C1 DV Free",
"Domain": "ninghhuang.online",
"Alias": "Auto-renewal Cert of K926htp2"
"Status": 1,
"VulnerabilityStatus": "INACTIVE",
"StatusMsg": null,
"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": "Certificate issued"
"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": null,
"CAEncryptAlgorithms": [],
"CAEndTimes": [],
"CACommonNames": [],
"Deployable": true,
"AwaitingValidationMsg": "",
"ProjectInfo": {
"ProjectId": "0",
"OwnerUin": 0,
"ProjectName": "Default Project"
"ProjectCreatorUin": 0,
"ProjectCreateTime": "0000-00-00 00:00:00",
"ProjectResume": "Default Project"
},
"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": null
},
"AllowDownload": null,
"IsPackage": false,
"HostingStatus": 0,
"HostingCompleteTime": "2025-02-05 08:39:30",
"HostingRenewCertId": null,
"HostingResourceTypes": [
"cdn",
"clb",
"cos"
],
"HostingConfig": {
"MessageTypes": [
0
],
"ReplaceEndTime": "23:59:59",
"ReplaceStartTime": "00:00:00",
"ReplaceTime": 999
},
"IsDNSPODResolve": false,
"BoundResource": null
}
],
"RequestId": "e7f6021f-47bb-476b-a424-6a0cde19a1eb"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| FailedOperation |
Operation failed. |
| FailedOperation.AuthError |
You do not have permission to perform this operation. |
| FailedOperation.CAMAuthorizedFail |
A CAM authentication error occurred. |
| FailedOperation.CancelOrderFailed |
Failed to cancel the order. |
| FailedOperation.CannotBeDeletedIssued |
Failed to delete the certificate because it has been issued. |
| FailedOperation.CannotBeDeletedWithinHour |
Free certificates cannot be deleted within 1 hour after being applied for. |
| FailedOperation.CannotGetOrder |
Failed to get order information. Try again later. |
| FailedOperation.CertificateInvalid |
The certificate is invalid. |
| FailedOperation.CertificateMismatch |
The certificate and the private key do not match. |
| FailedOperation.CertificateNotFound |
The certificate does not exist. |
| FailedOperation.ExceedsFreeLimit |
The number of free certificates exceeds the maximum value. |
| FailedOperation.InvalidCertificateStatusCode |
The certificate status is incorrect. |
| FailedOperation.InvalidParam |
Incorrect parameters. |
| FailedOperation.NetworkError |
The CA system is busy. Try again later. |
| FailedOperation.NoProjectPermission |
You do not have the permission to operate on this project. |
| FailedOperation.NoRealNameAuth |
You have not completed the identity verification. |
| FailedOperation.OrderAlreadyReplaced |
This order has already been replaced. |
| FailedOperation.OrderReplaceFailed |
Failed to reissue a certificate. |
| FailedOperation.SystemError |
A system error occurred. |
| InternalError |
Internal error. |
| InternalError.BackendResponseEmpty |
The backend service response is empty. |
| LimitExceeded.RateLimitExceeded |
The API rate limit is reached. |