ListListenerCertificates -

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 token that determines the start point of the next query. Valid values: If this is your first and only query, ignore this parameter. If a next query is to be performed, set the value to the NextToken value returned in the last call to the ListListenerCertificates operation.
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 token that determines the start point of the next query. Valid values: If NextToken is not returned, it indicates that no additional results exist. If NextToken is returned, the value is the token that is used for the next query.
MaxResults	Integer	20	The maximum number of entries returned.
Certificates	Array of Certificates		Details about 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 the additional certificate. This parameter is not returned if the certificate is a default one.
State	String	active	The state of the certificate. active: The certificate is associated with a listener and takes effect. updating: The additional certificate is being replaced.

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>
        <State>active</State>
    </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",
    "State" : "active"
  } ]
}

Error codes

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