Last updated: 2020-06-08 16:16:04

1. API Description

Domain name for API request:

This API is used to obtain the certificate list.

A maximum of 5 requests can be initiated per second for this API.

2. Input Parameters

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 parameter. The value used for this API: DescribeCertificates.
Version Yes String Common parameter. The value used for this API: 2019-12-05.
Region No String Common parameter. This parameter is not required for this API.
Offset No Integer Pagination offset, starting from 0.
Limit No Integer Number of certificates on each page. The default value is 20.
SearchKey No String Keyword for search, which can be a certificate ID, alias, or domain name. For example, a8xHcaIs.
CertificateType No String Certificate type. CA: client certificate; SVR: server certificate.
ProjectId No Integer Project ID.
ExpirationSort No String Sorting by expiration time. DESC: descending; ASC: ascending.
CertificateStatus.N No Array of Integer Certificate status.
Deployable No Integer Whether the certificate can be deployed. 1: yes; 0: no.

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining certificate list

This example shows you how to obtain the certificate list.

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "Certificates": [
        "From": "trustasia",
        "SubjectAltName": null,
        "BoundResource": [],
        "CertificateExtra": {
          "OriginCertificateId": null,
          "ReplacedBy": null,
          "ReplacedFor": "a8xHcaIs",
          "DomainNumber": null,
          "RenewOrder": null
        "StatusName": "approved",
        "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": "Default project",
          "ProjectName": "Default project"
        "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": "",
        "CertificateId": "a90XEOtj",
        "Alias": "New order for a8xHcaIs",
        "IsWildcard": false,
        "PackageTypeName": "TrustAsia TLS RSA CA",
        "VulnerabilityStatus": "INACTIVE",
        "Deployable": true
    "TotalCount": 12,
    "RequestId": "43b82119-c648-4230-8d38-5be63f039549"

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


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.AuthError You do not have permission to perform this operation.
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 obtain 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.
InternalError Internal error.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback