Queries the server certificate of a TCP/SSL listener.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
nlb:ListListenerCertificates | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ListenerId | string | Yes | The ID of the listener. Specify the ID of a listener that uses SSL over TCP. | lsn-j49ht1jxxqyg45****@80 |
CertType | string | No | The type of the certificate. Valid values:
| Ca |
NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. Valid values:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
MaxResults | integer | No | The number of entries to return on each page. Valid values: 1 to 100. Default value: 20. | 20 |
RegionId | string | No | The ID of the region where the Network Load Balancer (NLB) instance is deployed. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
CertificateIds | array | No | The server certificates. Only one server certificate is supported. Note
This parameter takes effect only for listeners that use SSL over TCP.
| |
string | No | The server certificates. Only one server certificate is supported. Note
This parameter takes effect only for listeners that use SSL over TCP.
| 123157****** |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "2198BD6D-9EBB-5E1C-9C48-E0ABB79CF831",
"CertificateIds": [
"[ \"931****-cn-hangzhou\"]"
],
"Certificates": [
{
"CertificateId": "12315790343_166f8204689_1714763408_70998****",
"IsDefault": true,
"Status": "Associating",
"CertificateType": "Server"
}
],
"TotalCount": 1,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"MaxResults": 20
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | OperationDenied.Protocol | The operation is not allowed because of %s. |
400 | IllegalParam.%s | The param of %s is illegal. |
404 | ResourceNotFound.loadbalancer | The specified resource %s is not found. |
404 | ResourceNotFound.listener | The specified resource %s is not found. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-14 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-08-22 | The Error code has changed | View Change Details |
2023-06-07 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
2023-04-11 | The request parameters of the API has changed | View Change Details |