tencent cloud

All product documents
APIs
DocumentationAPIsGlobal Application Acceleration PlatformCertificate APIsDescribeCertificates
DescribeCertificates
Last updated: 2023-07-13 15:25:42
DescribeCertificates
Last updated: 2023-07-13 15:25:42

1. API Description

Domain name for API request: gaap.tencentcloudapi.com.

This API (DescribeCertificates) is used to query the list of available certificates.

A maximum of 20 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.

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 Params. The value used for this API: DescribeCertificates.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required.
CertificateType No Integer Certificate type. Where:
0: basic authentication configuration;
1: client CA certificate;
2: server SSL certificate;
3: origin server CA certificate;
4: connection SSL certificate.
-1: all types.
The default value is -1.
Offset No Integer Offset. The default value is 0.
Limit No Integer Quantity limit. The default value is 20.

3. Output Parameters

Parameter Name Type Description
CertificateSet Array of Certificate Server certificate list, which includes certificate ID and certificate name.
TotalCount Integer Total quantity of server certificates that match the query conditions.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying server certificate information

Input Example

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCertificates
<Common request parameters>

{
    "CertificateType": "2",
    "Limit": "1",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "TotalCount": 19,
        "RequestId": "35d85baa-eeb8-4eb5-96a9-b6d27f4ff92c",
        "CertificateSet": [
            {
                "CertificateId": "cert-8k1l0pat",
                "SubjectCN": "lagameft01.xyz",
                "CertificateAlias": "test",
                "CertificateName": "test",
                "BeginTime": 1554134400,
                "CertificateType": 2,
                "EndTime": 1585713600,
                "CreateTime": 1564557014,
                "IssuerCN": "TrustAsia TLS RSA CA"
            }
        ]
    }
}

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
AuthFailure CAM signature/authentication error.
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
AuthFailure.UnauthorizedOperation The sub-account is not authorized for this operation.
FailedOperation Operation failed.
FailedOperation.UserNotConfirmProtocol Protocol not activated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon