Queries certificates associated with a 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.

RegionId String Yes cn-hangzhou

The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

AcceleratorId String Yes ga-bp1odcab8tmno0hdq****

The ID of the GA instance.

Role String No default

The type of the certificate. Valid values:

  • default: a default certificate
  • additional: an additional certificate

If you do not set this parameter, default and additional certificates are returned by default.

ListenerId String Yes lsr-bp1bpn0kn908w4nbw****

The ID of the listener.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The position where the query starts. If this parameter is left empty, the query starts from the beginning.

MaxResults Integer No 50

The number of entries to return.

Valid values: 1 to 50. Default value: 20.

Response parameters

Parameter Type Example Description
RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

The ID of the request.

TotalCount Integer 1

The total number of entries returned.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

The position where the query starts. If this parameter is left empty, the query starts from the beginning.

MaxResults Integer 20

The total number of entries returned.

Certificates Array of Certificates

The certificates.

CertificateId String 6092**-cn-hangzhou

The ID of the certificate.

IsDefault Boolean true

Indicates whether the certificate is a default one:

  • true: a default certificate
  • false: an additional certificate
Domain String example.com

The domain name associated with an additional certificate. This parameter is not returned if the certificate is a default one.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListListenerCertificates
&RegionId=cn-hangzhou
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&Role=default
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&NextToken=caeba0bbb2be03f84eb48b699f0a4883
&MaxResults=50
&Common request parameters

Sample success responses

XML format

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

<ListListenerCertificatesResponse>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>
    <TotalCount>1</TotalCount>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <MaxResults>20</MaxResults>
    <Certificates>
        <CertificateId>6092**-cn-hangzhou</CertificateId>
        <IsDefault>true</IsDefault>
        <Domain>example.com</Domain>
    </Certificates>
</ListListenerCertificatesResponse>

JSON format

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

{
  "RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "TotalCount" : 1,
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "MaxResults" : 20,
  "Certificates" : [ {
    "CertificateId" : "6092**-cn-hangzhou",
    "IsDefault" : true,
    "Domain" : "example.com"
  } ]
}

Error codes

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