DescribeDefaultCertificates
1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query a list of default 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: DescribeDefaultCertificates. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | No | String | Zone ID. |
| Filters.N | No | Array of Filter | Filter criteria. Each filter criteria can have up to 5 entries.zone-id: Filter by site ID, such as zone-xxx Type: String Required: No |
| Offset | No | Integer | Offset for paginated queries. Default value: 0 |
| Limit | No | Integer | Limit on paginated queries. Default value: 20. Maximum value: 100. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of certificates |
| DefaultServerCertInfo | Array of DefaultServerCertInfo | List of default certificates |
| 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 Obtaining the default certificate
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDefaultCertificates
<Common Request Parameters>
{
"Filters": [
{
"Name": "zone-id",
"Values": [
"zone-fafcasdf"
]
}
]
}
Output Example
{
"Response": {
"TotalCount": 1,
"RequestId": "084d5612-67a7-4aca-aac9-827aa3662b2d",
"DefaultServerCertInfo": [
{
"Status": "deployed",
"CertId": "teo-285inl1otbtd",
"SubjectAltName": [
"*.test.com",
"test.com"
],
"EffectiveTime": "2020-09-22T00:00:00+00:00",
"CommonName": "test.com",
"ExpireTime": "2020-09-22T00:00:00+00:00",
"Alias": "EdgeOne default",
"Message": "",
"Type": "default"
}
]
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- 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 Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| InternalError.DBError | Database error. |
| InternalError.ProxyServer | An unknown error occurred in the backend server. |
| InternalError.RouteError | The backend routing address is incorrect. |
| InternalError.SystemError | Internal system error. |
| InvalidParameter.ZoneNotFound | The site does not exist. |
| OperationDenied | Operation denied. |
| ResourceUnavailable.ZoneNotFound | The site does not exist or is not belong to this account. |
| UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
| UnauthorizedOperation.NoPermission | The sub-account is not authorized for the operation. Please get permissions first. |