All Products
Search
Document Center

Server Load Balancer:ListListenerCertificates

Last Updated:Mar 13, 2024

Queries the server certificates of a listener that uses SSL over TCP.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
nlb:ListListenerCertificatesList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ListenerIdstringYes

The ID of the listener. Specify the ID of a listener that uses SSL over TCP.

lsn-j49ht1jxxqyg45****@80
CertTypestringNo

The type of the certificate. Valid values:

  • Server: a server certificate.
  • Ca: Certificate Authority Certificate
Server
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. Valid values:

  • You do not need to specify this parameter for the first request.
  • You must specify the token that is obtained from the previous query as the value of NextToken.
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.

20
RegionIdstringNo

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

2198BD6D-9EBB-5E1C-9C48-E0ABB79CF831
CertificateIdsarray

The server certificates.

string

The server certificates. Only one server certificate is supported.

Note This parameter takes effect only for listeners that use SSL over TCP.
[ "931****-cn-hangzhou"]
Certificatesobject []

The certificates.

CertificateIdstring

The ID of the certificate.

12315790343_166f8204689_1714763408_70998****
IsDefaultboolean

Indicates whether the certificate is the default certificate of the listener. Valid values:

  • true
  • false
true
Statusstring

Indicates whether the certificate is associated with the listener. Valid values:

  • Associating
  • Associated
  • Diassociating
Associating
CertificateTypestring

The type of the certificate.

  • Server
  • Ca
Server
TotalCountinteger

The total number of entries returned.

1
NextTokenstring

The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:

  • You do not need to specify this parameter for the first request.
  • You must specify the token that is obtained from the previous query as the value of NextToken.
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

The number of entries returned per page. Valid values: 1 to 100. Default value: 20.

20

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400OperationDenied.ProtocolThe operation is not allowed because of %s.
400IllegalParam.%sThe param of %s is illegal.
404ResourceNotFound.loadbalancerThe specified resource %s is not found.
404ResourceNotFound.listenerThe specified resource %s is not found.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-22The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404
2023-06-07The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
    Added Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: CertType
Output ParametersThe response structure of the API has changed.
2023-04-11The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: Page
    delete Input Parameters: PageSize