Documentation|Tencent Cloud

Recent Pages

Documentation

DescribeCertificates

Last updated: 2020-07-24 15:09:37

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 parameter. The value used for this API: DescribeCertificates.
Version	Yes	String	Common parameter. The value used for this API: 2018-05-29.
Region	No	String	Common parameter. This parameter is not required for this API.
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

https://gaap.tencentcloudapi.com/?Action=DescribeCertificates
&CertificateType=2
&Offset=0
&Limit=1
&<Common request parameters>

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

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.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
InternalError	Internal error
InvalidParameter	Parameter error
InvalidParameterValue	Parameter value error
MissingParameter	Parameter missing
UnauthorizedOperation	Unauthorized operation
UnknownParameter	Unknown parameter error
UnsupportedOperation	This operation is not supported.