All Products
Search
Document Center

Server Load Balancer:ListListenerCertificates

Last Updated:Jul 04, 2024

Queries the certificates that are associated with a listener, including additional certificates and the default certificate.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
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 maximum number of entries to return. Valid values: 1 to 100. Default value: 20.

50
ListenerIdstringYes

The listener ID. You must specify the ID of an HTTPS listener or a QUIC listener.

lsr-bp1bpn0kn908w4nbw****
CertificateTypestringNo

The type of the certificate. Valid values: Ca and Server.

Server

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

MaxResultsinteger

The maximum number of entries returned.

50
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. Valid values:

  • If NextToken is empty, no next page exists.
  • If a value is returned for NextToken, the value is the token that determines the start point of the next query.
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

The request ID.

365F4154-92F6-4AE4-92F8-7FF34B540710
TotalCountinteger

The total number of entries returned.

1000
Certificatesarray<object>

The certificates.

object

The certificate.

CertificateIdstring

The certificate ID. Only server certificates are supported.

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

Examples

Sample success responses

JSONformat

{
  "MaxResults": 50,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount": 1000,
  "Certificates": [
    {
      "CertificateId": "12315790343_166f8204689_1714763408_70998****",
      "IsDefault": true,
      "Status": "Associating",
      "CertificateType": "Server"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400OperationDenied.HttpListenerNotSupportThe operation is not allowed because of %s.The operation is not allowed because of %s.
404ResourceNotFound.ListenerThe specified resource %s is not found.The specified resource %s is not found.

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

Change history

Change timeSummary of changesOperation
2024-06-05The Error code has changed. The request parameters of the API has changedView Change Details