All Products
Search
Document Center

Server Load Balancer:ListListenerCertificates

Last Updated:Jun 18, 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

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
alb:ListListenerCertificatesRead
  • LoadBalancer
    acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
    none
none

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. If you do not specify this parameter, the default value 20 is used.

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
Certificatesobject []

The certificates.

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 changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: CertificateIds