Queries the extended validation certificates and default certificates 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 start position of the query. If this parameter is left empty, the query starts from the beginning.

MaxResults Integer No 50

The maximum number of data records to be queried.

Valid values: 1 to 100.

Default value: 20. This value indicates that no certificates have been uploaded.

ListenerId String No 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 data records returned.

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

The position where the query stopped. If the response does not contain this parameter, all data has been queried.

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

The ID of the request.

TotalCount Integer 1000

The total data volume of the request.

Certificates Array of CertificateModel

The certificates.

CertificateId String 12315790343_166f8204689_1714763408_70998****

The certificate ID. Only IDs of server certificates are returned.

IsDefault Boolean true

Indicates whether the certificate is a default certificate:

  • true: The certificate is a default certificate.
  • false: The certificate is an extended validation certificate.
Status String Associating

The status of association between the certificate and the listener:

  • Associating: The certificate is being associated with the listener.
  • Associated: The certificate is associated with the listener.
  • Diassociating: The certificate is being disassociated with 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 for %s.
404 ResourceNotFound.Listener The specified resource %s is not found. The error message returned because the specified resource %s does not exist.

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