List listeners using ListListeners - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries a list of listeners.

Operation description

Queries the list of listeners under an Alibaba Cloud Global Accelerator (GA) instance, including the routing type, status, creation UNIX timestamp, and port information of each listener.

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:ListListeners

list

*Listener

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 50. Default value: 10.	10
AcceleratorId	string	Yes	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance.	ga-bp1odcab8tmno0hdq****
Protocol	string	No	The transport protocol type of the listener network.	HTTP

Response elements

Element	Type	Description	Example
	object	The response information list.
TotalCount	integer	The total number of entries in the list.	1
Listeners	array<object>	The listener information.
	array<object>	The listener information.
Certificates	array<object>	The SSL certificate information.
	object	The SSL certificate information.
Type	string	The certificate type. Currently, only Server (server certificate) is supported.	Server
Id	string	The SSL certificate ID.	44983xxxx-cn-hangzhou
BackendPorts	array<object>	The backend server Server Port information.
	object	The backend server Server Port information.
FromPort	string	The start port of the backend server.	80
ToPort	string	The end port of the backend server.	80
ListenerId	string	The listener ID.	lsr-bp1bpn0kn908w4nbw****
Description	string	The description of the listener.	Listener
State	string	The status of the listener. active: Normal. init: Initializing. updating: Being configured. deleting: Being deleted.	active
ClientAffinity	string	The client affinity. If NONE is returned, client affinity is not maintained. Connections from the same client are not always directed to the same endpoint. If SOURCE_IP is returned, client affinity is maintained. When a client accesses a stateful application, all requests from the same client are directed to the same endpoint, regardless of the source port and protocol.	SOURCE_IP
Protocol	string	The transport protocol type of the listener. TCP: TCP protocol. UDP: UDP protocol. HTTP: HTTP protocol. HTTPS: HTTPS protocol.	TCP
CreateTime	integer	The timestamp when the listener was created. Unit: milliseconds.	1577786252000
PortRanges	array<object>	The listener port information.
	object	The listener port information.
FromPort	integer	The start listening port used to receive requests and forward them to endpoints.	20
ToPort	integer	The end listening port used to receive requests and forward them to endpoints.	20
Name	string	The name of the listener.	Listener
ProxyProtocol `deprecated`	boolean	Indicates whether the client source IP address preservation feature is enabled. true: The client source IP address preservation feature is enabled. After this feature is enabled, the backend service can view the original IP address of the client. false: The client source IP address preservation feature is not enabled.	true
AcceleratorId	string	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance.	ga-bp1odcab8tmno0hdq****
XForwardedForConfig	object	The `XForward` field configuration information.
XForwardedForGaIdEnabled	boolean	Indicates whether the `GA-ID` header field is used to retrieve the Alibaba Cloud Global Accelerator (GA) instance ID. true: yes. false: no. Note Only HTTP and HTTPS listeners support this parameter.	false
XRealIpEnabled	boolean	Indicates whether the `X-Real-IP` field is used to retrieve the real client IP address. true: yes. false: no. Note Only HTTP and HTTPS listeners support this parameter.	false
XForwardedForGaApEnabled	boolean	Indicates whether the `GA-AP` field is used to retrieve the acceleration area information. true: yes. false: no. Note Only HTTP and HTTPS listeners support this parameter.	false
XForwardedForProtoEnabled	boolean	Indicates whether the `GA-X-Forward-Proto` field is used to retrieve the listener protocol of the Alibaba Cloud Global Accelerator (GA) instance. true: yes. false: no. Note Only HTTP and HTTPS listeners support this parameter.	false
XForwardedForPortEnabled	boolean	Indicates whether the `GA-X-Forward-Port` field is used to retrieve the listener port of the Alibaba Cloud Global Accelerator (GA) instance. true: yes. false: no. Note Only HTTP and HTTPS listeners support this parameter.	false
SecurityPolicyId	string	The security policy instance ID. tls_cipher_policy_1_0 Supported TLS versions: TLSv1.0, TLSv1.1, and TLSv1.2. Supported encryption algorithm suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA. tls_cipher_policy_1_1 Supported TLS versions: TLSv1.1 and TLSv1.2. Supported encryption algorithm suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA. tls_cipher_policy_1_2 Supported TLS versions: TLSv1.2. Supported encryption algorithm suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA. tls_cipher_policy_1_2_strict Supported TLS versions: TLSv1.2. Supported encryption algorithm suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA, and ECDHE-RSA-AES256-SHA. tls_cipher_policy_1_2_strict_with_1_3 Supported TLS versions: TLSv1.2 and TLSv1.3. Supported encryption algorithm suites: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_AES_128_CCM_8_SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA, and ECDHE-RSA-AES256-SHA. Note Only HTTPS listeners support this parameter.	tls_cipher_policy_1_0
Type	string	The routing type of the listener. Standard: intelligent routing type. CustomRouting: custom routing type.	Standard
ServiceId	string	The ID of the service to which the managed instance belongs. Note This parameter is valid only when ServiceManaged is set to True.	ALB
ServiceManaged	boolean	Indicates whether the instance is managed. Valid values: true: The instance is managed. false: The instance is not managed.	true
ServiceManagedInfos	array<object>	The list of action policies that the user can execute on the managed instance. Note This parameter is valid only when ServiceManaged is set to True. When the instance is in a managed state, user operations on the instance are restricted, and certain actions are prohibited.
	object	The list of action policies that the user can execute on the managed instance.
Action	string	The name of the managed policy action. Valid values: Create: Create an instance. Update: Update the current instance. Delete: Delete the current instance. Associate: Reference or be referenced by the current instance. UserUnmanaged: Unmanage the instance by the user. CreateChild: Create a child resource under the current instance.	Update
ChildType	string	The child resource type. Valid values: Listener: listener resource. IpSet: acceleration region resource. EndpointGroup: endpoint group resource. ForwardingRule: forwarding rule resource. Endpoint: endpoint resource. EndpointGroupDestination: protocol mapping resource of the endpoint group under a custom routing listener. EndpointPolicy: endpoint traffic policy resource under a custom routing listener. Note This parameter is valid only when Action is set to CreateChild.	Listener
IsManaged	boolean	Indicates whether the managed policy action is managed. Valid values: true: The managed policy action is managed. The user cannot perform the action specified by Action on the managed instance. false: The managed policy action is not managed. The user can perform the action specified by Action on the managed instance.	false
IdleTimeout	integer	The idle connection timeout period. Unit: seconds.	900
RequestTimeout	integer	The HTTP/HTTPS connection request timeout period. Unit: seconds. Note This parameter is valid only for listeners whose Protocol (transport protocol type) is HTTP or HTTPS. If the backend server does not return a response within the timeout period, Global Accelerator stops waiting and returns an HTTP 504 error code to the client.	60
HttpVersion	string	The maximum HTTP protocol version. Valid values: http3: HTTP/3. http2: HTTP/2. http1.1: HTTP/1.1. Note Only HTTPS listeners support this parameter.	http2
PageSize	integer	The number of entries per page for a paged query.	10
RequestId	string	The request ID.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
PageNumber	integer	The page number of the list.	1

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "Listeners": [
    {
      "Certificates": [
        {
          "Type": "Server",
          "Id": "44983xxxx-cn-hangzhou"
        }
      ],
      "BackendPorts": [
        {
          "FromPort": "80",
          "ToPort": "80"
        }
      ],
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "Description": "Listener",
      "State": "active",
      "ClientAffinity": "SOURCE_IP",
      "Protocol": "TCP",
      "CreateTime": 1577786252000,
      "PortRanges": [
        {
          "FromPort": 20,
          "ToPort": 20
        }
      ],
      "Name": "Listener",
      "ProxyProtocol": true,
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "XForwardedForConfig": {
        "XForwardedForGaIdEnabled": false,
        "XRealIpEnabled": false,
        "XForwardedForGaApEnabled": false,
        "XForwardedForProtoEnabled": false,
        "XForwardedForPortEnabled": false
      },
      "SecurityPolicyId": "tls_cipher_policy_1_0",
      "Type": "Standard",
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ],
      "IdleTimeout": 900,
      "RequestTimeout": 60,
      "HttpVersion": "http2"
    }
  ],
  "PageSize": 10,
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "PageNumber": 1
}

Error codes

HTTP status code	Error code	Error message	Description
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.