Domain name for API request: alb.intl.tencentcloudapi.com.
This API is used to query the list of certificates bound to a specified listener by instance id and listener id.
If CertificateType is set to SVR, the information of the extended server certificate and the default server certificate is returned.
If CertificateType is set to CA, the default CA certificate info is returned.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeListenerCertificates. |
| Version | Yes | String | Common Params. The value used for this API: 2025-10-30. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| CertificateType | Yes | String | Certificate type. Value: CA or SVR (server certificate). |
| ListenerId | Yes | String | Listener ID, in the format of lst- followed by 8 alphanumeric characters. |
| LoadBalancerId | Yes | String | CLB instance ID. The format is alb- followed by 8 alphanumeric characters. |
| MaxResults | No | Integer | Maximum number of data records to read this time. Value range: 1-100. Default value: 20. |
| NextToken | No | String | Token for the next query. Value: Not required for the first query or when there is no next query. If there is a next query, the value is the NextToken value returned from the last API call. |
| Parameter Name | Type | Description |
|---|---|---|
| Certificates | Array of CertificateInfo | List of listener bound certificate information. |
| MaxResults | Integer | Maximum number of data records read this time. |
| NextToken | String | Token for the next query. |
| TotalCount | Integer | Total amount of listener bound 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. |
POST / HTTP/1.1
Host: alb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeListenerCertificates
<Common request parameters>
{
"CertificateType": "SVR",
"ListenerId": "lst-d9p3k7wa",
"LoadBalancerId": "alb-f8q2xk9m",
"MaxResults": 20
}{
"Response": {
"Certificates": [
{
"CertificateId": "Fm8Wp7x8",
"CertificateType": "SVR",
"AssociatedTime": "2024-06-12T10:34:56Z",
"IsDefault": true,
"Status": "Associated"
}
],
"MaxResults": 20,
"NextToken": "2c44874464923a9f",
"TotalCount": 200,
"RequestId": "3b848733-70e5-4558-ae39-4b9938eb7609"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| MissingParameter | Parameters are missing. |
| OperationDenied | Operation denied. |
| RegionError | Region error |
| RequestLimitExceeded | Number of requests exceeds the frequency limit. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | The operation is not supported. |
フィードバック