Help Center/ Global Accelerator/ API Reference/ API/ Listener/ Querying Listeners

Updated on 2025-11-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Listeners

Function

This API is used to query listeners.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ga:listener:list	List	listener *	-	-	-

URI

GET /v1/listeners

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the number of resources on each page. If this parameter is not specified, the default value is 500.
marker	No	String	Specifies the ID of the resource from which pagination query starts, that is, the ID of the last resource on the previous page. If the parameter is not specified, only resources on the first page are queried. This parameter must be used together with limit.
page_reverse	No	Boolean	Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.
id	No	String	Specifies the resource ID.
name	No	String	Specifies the resource name. The name can contain 0 to 64 characters. Only letters, digits, and hyphens (-) are allowed.
status	No	String	Specifies the resource status. The value can be one of the following: ACTIVE: The resource is running. PENDING: The status is to be determined. ERROR: Failed to create the resource. DELETING: The resource is being deleted.
accelerator_id	No	String	Specifies the global accelerator ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
listeners	Array of ListenerDetail objects	Specifies the listeners.
page_info	PageInfo object	Specifies the pagination query information.
request_id	String	Specifies the request ID.

**Table 4** ListenerDetail
Parameter	Type	Description
id	String	Specifies the listener ID.
name	String	Specifies the listener name. The name can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.
description	String	Specifies the information about the listener. The value can contain 0 to 255 characters. The following characters are not allowed: <>
protocol	String	The protocol used by listeners to forward requests. Value range: TCP and UDP
status	String	Specifies the provisioning status. The value can be one of the following: ACTIVE: The resource is running. PENDING: The status is to be determined. ERROR: Failed to create the resource. DELETING: The resource is being deleted.
port_ranges	Array of PortRange objects	Specifies the port range used by the listener.
client_affinity	String	Specifies the client affinity. The value can be one of the following: Source IP address: Requests from the same IP address are forwarded to the same endpoint. NONE: Requests are evenly forwarded across the endpoints.
accelerator_id	String	Specifies the ID of the global accelerator associated with the listener.
created_at	String	Specifies when the listener was added.
updated_at	String	Specifies when the listener was updated.
domain_id	String	Specifies the tenant ID.
frozen_info	FrozenInfo object	Specifies the frozen details of cloud services or resources.
tags	Array of ResourceTag objects	Specifies the tags.

**Table 5** PortRange
Parameter	Type	Description
from_port	Integer	Specifies the start port number.
to_port	Integer	Specifies the end port number.

**Table 6** FrozenInfo
Parameter	Type	Description
status	Integer	Specifies the status of a cloud service or resource. The value can be one of the following: 0: unfrozen/normal (The cloud service will recover after being unfrozen.) 1: frozen (Resources and data will be retained, but the cloud service cannot be used.) 2: deleted/terminated (Both resources and data will be cleared.)
effect	Integer	Specifies the status of the resource after being frozen. The value can be one of the following: 1 (default): The resource is frozen and can be released. 2: The resource is frozen and cannot be released. 3: The resource is frozen and cannot be renewed.
scene	Array of strings	Specifies the service scenario. The value can be one of the following: ARREAR: The cloud service is in arrears, including expiration of yearly/monthly resources and fee deduction failure of pay-per-use resources. POLICE: The cloud service is frozen for public security. ILLEGAL: The cloud service is frozen due to violation of laws and regulations. VERIFY: The cloud service is frozen because the user fails to pass the real-name authentication. PARTNER: A partner freezes their customer's resources.

**Table 7** ResourceTag
Parameter	Type	Description
key	String	The tag key. A key can contain 1 to 128 characters. It cannot be left blank. A key can contain UTF-8 letters, digits, spaces, and the following characters _.:=+-@ Do not enter a tag key starting with *sys. Tag keys starting with sys* are system tags.
value	String	The tag value. A value can contain 0 to 255 characters. A value can contain UTF-8 letters, digits, spaces, and the following characters _.:/=+-@ The tag value can be empty or null.

**Table 8** PageInfo
Parameter	Type	Description
next_marker	String	Specifies the marker of the next page. If this parameter is left empty, the resource is on the last page.
current_count	Integer	Specifies the number of resources on the current list.

Example Requests

Querying listeners

GET https://{ga_endpoint}/v1/listeners

Example Responses

Status code: 200

Operation succeeded.

{
  "listeners" : [ {
    "id" : "1b11747a-b139-492f-9692-2df0b1c87193",
    "name" : "listenerName",
    "description" : "listener description",
    "protocol" : "TCP",
    "status" : "ACTIVE",
    "port_ranges" : [ {
      "from_port" : 4000,
      "to_port" : 4200
    } ],
    "client_affinity" : "SOURCE_IP",
    "accelerator_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8",
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    },
    "tags" : [ {
      "key" : "tagKey",
      "value" : "tagValue"
    } ]
  } ],
  "page_info" : {
    "next_marker" : "1b11747a-b139-492f-9692-2df0b1c87193",
    "current_count" : 1
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}