All Products
Search
Document Center

Global Accelerator:ListListenerCertificates

Last Updated:Apr 10, 2024

Queries certificates that are 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.

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
ga:ListListenerCertificatesList
  • Listener
    acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
AcceleratorIdstringYes

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
RolestringNo

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.

default
ListenerIdstringYes

The ID of the listener.

lsr-bp1bpn0kn908w4nbw****
NextTokenstringNo

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.
caeba0bbb2be03f84eb48b699f0a4883
MaxResultsintegerNo

The number of entries to return.

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

50

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

6FEA0CF3-D3B9-43E5-A304-D217037876A8
TotalCountinteger

The total number of entries returned.

1
NextTokenstring

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.
caeba0bbb2be03f84eb48b699f0a4883
MaxResultsinteger

The maximum number of entries returned.

20
Certificatesobject []

Details about the certificates.

CertificateIdstring

The ID of the certificate.

6092**-cn-hangzhou
IsDefaultboolean

Indicates whether the certificate is a default one:

  • true: a default certificate
  • false: an additional certificate
true
Domainstring

The domain name associated with the additional certificate.

This parameter is not returned if the certificate is a default one.

example.com
Statestring

The state of the certificate.

  • active: The certificate is associated with a listener and takes effect.
  • updating: The additional certificate is being replaced.
active

Examples

Sample success responses

JSONformat

{
  "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 Service error codes.

Change history

Change timeSummary of changesOperation
No change history