ListListenerCertificates - Query listener certificates - Global Accelerator

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:ListListenerCertificates

list

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Region of the GA instance. Set to cn-hangzhou.	cn-hangzhou
AcceleratorId	string	Yes	The ID of the GA instance.	ga-bp1odcab8tmno0hdq****
Role	string	No	Certificate type. Valid values: default additional If not specified, both types are returned.	default
ListenerId	string	Yes	The ID of the listener.	lsr-bp1bpn0kn908w4nbw****
NextToken	string	No	Pagination token for subsequent requests. Usage: Omit for the first request. Set to the value returned in the previous response.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	Maximum entries to return. Valid values: 1 to 50. Default: 20.	50

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
TotalCount	integer	The number of entries returned.	1
NextToken	string	Pagination token for the next query. Values: Empty: no more pages. Non-empty: use as the NextToken in the next request.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	Maximum entries returned per page.	20
Certificates	array<object>	The certificates.
	object
CertificateId	string	The certificate ID.	6092**-cn-hangzhou
IsDefault	boolean	Whether this is the default certificate. true false	true
Domain	string	Domain name bound to the additional certificate. Not returned for default certificates.	example.com
State	string	Certificate status. Valid values: active: bound to a listener and in effect. updating: the additional certificate is being replaced.	active

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.