Queries the additional certificates and default certificate of a specified HTTPS or QUIC listener.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListListenerCertificates

The operation that you want to perform. Set the value to ListListenerCertificates.

NextToken String No FFmyTO70tTpLG6I3FmYAXGKPd****

The token that is used for the next query. Valid values:

  • If this is your first query or no next query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
MaxResults Integer No 50

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.

ListenerId String Yes lsr-bp1bpn0kn908w4nbw****

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

CertificateType String No Server

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

Response parameters

Parameter Type Example Description
MaxResults Integer 50

The maximum number of entries returned.

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

The token that is used for the next query. Valid values:

  • If NextToken is empty, it indicates that no next query is to be sent.
  • If NextToken is not empty, the value indicates the token that is used for the next query.
RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

The ID of the request.

TotalCount Integer 1000

The total number of entries returned.

Certificates Array of CertificateModel

The list of certificates.

CertificateId String 12315790343_166f8204689_1714763408_70998****

The ID of the certificate. Only server certificates are supported.

IsDefault Boolean true

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

  • true: the default certificate
  • false: an additional certificate
Status String Associating

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

  • Associating: The certificate is being associated with the listener.
  • Associated: The certificate is associated with the listener.
  • Diassociating: The certificate is being disassociated from the listener.
CertificateType String Server

The type of the certificate.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListListenerCertificates
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=50
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&CertificateType=Server
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListListenerCertificatesResponse>
    <MaxResults>50</MaxResults>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <TotalCount>1000</TotalCount>
    <Certificates>
        <CertificateId>12315790343_166f8204689_1714763408_70998****</CertificateId>
        <IsDefault>true</IsDefault>
        <Status>Associating</Status>
        <CertificateType>Server</CertificateType>
    </Certificates>
</ListListenerCertificatesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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

HttpCode Error code Error message Description
400 OperationDenied.HttpListenerNotSupport The operation is not allowed because of %s. The error message returned because the operation is not allowed due to %s.
404 ResourceNotFound.Listener The specified resource %s is not found. The error message returned because the specified %s resource does not exist.

For a list of error codes, visit the API Error Center.