Querying Listeners

Function

This API is used to query listeners.

Constraints

This API has the following constraints:

  • Parameters marker, limit, and page_reverse are used for pagination query.

  • Parameters marker and page_reverse take effect only when they are used together with parameter limit.

URI

GET /v3/{project_id}/elb/listeners

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Specifies the number of records on each page.

Minimum: 0

Maximum: 2000

Default: 2000

marker

No

String

Specifies the ID of the last record on the previous page.

Note:

  • This parameter must be used together with limit.

  • If this parameter is not specified, the first page will be queried.

  • This parameter cannot be left blank or set to an invalid ID.

page_reverse

No

Boolean

Specifies whether to use reverse query. Values:

  • true: Query the previous page.

  • false (default): Query the next page.

Note:

  • This parameter must be used together with limit.

  • If page_reverse is set to true and you want to query the previous page, set the value of marker to the value of previous_marker.

protocol_port

No

Array

Specifies the port used by the listener.

Multiple ports can be queried in the format of protocol_port=xxx&protocol_port=xxx.

protocol

No

Array

Specifies the protocol used by the listener.

The value can be TCP, HTTP, UDP, HTTPS or TERMINATED_HTTPS.

Note: TERMINATED_HTTPS is only available for the listeners of shared load balancers.

Multiple protocols can be queried in the format of protocol=xxx&protocol=xxx.

description

No

Array

Provides supplementary information about the listener.

Multiple descriptions can be queried in the format of description=xxx&description=xxx.

default_tls_container_ref

No

Array

Specifies the ID of the server certificate used by the listener.

Multiple IDs can be queried in the format of default_tls_container_ref=xxx&default_tls_container_ref=xxx.

client_ca_tls_container_ref

No

Array

Specifies the ID of the CA certificate used by the listener.

Multiple IDs can be queried in the format of client_ca_tls_container_ref=xxx&client_ca_tls_container_ref=xxx.

admin_state_up

No

Boolean

Specifies the administrative status of the listener. The value can only be true.

This parameter is unsupported. Please do not use it.

connection_limit

No

Array

Specifies the maximum number of connections that the load balancer can establish with backend servers. The value -1 indicates that the number of connections is not limited.

Multiple values can be queried in the format of connection_limit=xxx&connection_limit=xxx.

This parameter is unsupported. Please do not use it.

default_pool_id

No

Array

Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests will be routed to the default backend server.

Multiple IDs can be queried in the format of default_pool_id=xxx&default_pool_id=xxx.

id

No

Array

Specifies the listener ID.

Multiple IDs can be queried in the format of id=xxx&id=xxx.

name

No

Array

Specifies the name of the listener added to the load balancer.

Multiple names can be queried in the format of name=xxx&name=xxx.

http2_enable

No

Boolean

Specifies whether to use HTTP/2 if you want the clients to use HTTP/2 to communicate with the listener. However, connections between the load balancer and backend servers still use HTTP/1.x by default.

This parameter is available only for HTTPS listeners. If you configure this parameter for listeners with other protocols, it will not take effect.

loadbalancer_id

No

Array

Specifies the ID of the load balancer that the listener is added to.

Multiple IDs can be queried in the format of loadbalancer_id=xxx&loadbalancer_id=xxx.

tls_ciphers_policy

No

Array

Specifies the security policy used by the listener.

Multiple security policies can be queried in the format of tls_ciphers_policy=xxx&tls_ciphers_policy=xxx.

member_address

No

Array

Specifies the private IP address bound to the backend server. This parameter is used only as a query condition and is not included in the response.

Multiple IP addresses can be queried in the format of member_address=xxx&member_address=xxx.

member_device_id

No

Array

Specifies the ID of the cloud server that serves as a backend server. This parameter is used only as a query condition and is not included in the response.

Multiple IDs can be queried in the format of member_device_id=xxx&member_device_id=xxx.

enterprise_project_id

No

Array

Specifies the enterprise project ID.

  • If this parameter is not passed, resources in the default enterprise project are queried, and authentication is performed based on the default enterprise project.

  • If this parameter is passed, its value can be the ID of an existing enterprise project (resources in the specific enterprise project are required) or all_granted_eps (resources in all enterprise projects are queried).

Multiple IDs can be queried in the format of enterprise_project_id=xxx&enterprise_project_id=xxx.

This parameter is unsupported. Please do not use it.

enable_member_retry

No

Boolean

Specifies whether to enable health check retries for backend servers.

The value can be true (enable health check retries) or false (disable health check retries).

member_timeout

No

Array

Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

The value ranges from 1 to 300.

Multiple durations can be queried in the format of member_timeout=xxx&member_timeout=xxx.

client_timeout

No

Array

Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

  • If the client fails to send a request header to the load balancer within the timeout duration, the request will be interrupted.

  • If the interval between two consecutive request bodies reaching the load balancer is greater than the timeout duration, the connection will be disconnected.

The value ranges from 1 to 300.

Multiple durations can be queried in the format of client_timeout=xxx&client_timeout=xxx.

keepalive_timeout

No

Array

Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

  • For TCP listeners, the value ranges from 10 to 4000.

  • For HTTP, HTTPS, and TERMINATED_HTTPS listeners, the value ranges from 1 to 4000.

  • For UDP listeners, this parameter does not take effect.

Multiple durations can be queried in the format of keepalive_timeout=xxx&keepalive_timeout=xxx.

transparent_client_ip_enable

No

Boolean

Specifies whether to pass source IP addresses of the clients to backend servers.

This parameter is only available for TCP or UDP listeners of shared load balancers.

  • true: Source IP addresses will be passed to backend servers.

  • false: Source IP addresses will not be passed to backend servers.

enhance_l7policy_enable

No

Boolean

Specifies whether to enable advanced forwarding. If you enable this function, you can configure more flexible forwarding policies and rules.

  • true: Enable advanced forwarding.

  • false: Disable advanced forwarding.

member_instance_id

No

Array

Specifies the backend server ID. This parameter is used only as a query condition and is not included in the response. Multiple IDs can be queried in the format of member_instance_id=xxx&member_instance_id=xxx.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the token used for IAM authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID. The value is automatically generated.

page_info

PageInfo object

Shows pagination information about listeners.

listeners

Array of Listener objects

Lists the listeners.

Table 5 PageInfo

Parameter

Type

Description

previous_marker

String

Specifies the ID of the first record in the pagination query result.

next_marker

String

Specifies the ID of the last record in the pagination query result.

current_count

Integer

Specifies the number of records.

Table 6 Listener

Parameter

Type

Description

admin_state_up

Boolean

Specifies the administrative status of the listener. The value can only be true.

This parameter is unsupported. Please do not use it.

client_ca_tls_container_ref

String

Specifies the ID of the CA certificate used by the listener. This parameter is available only when type is set to client.

connection_limit

Integer

Specifies the maximum number of connections that the load balancer can establish with backend servers. The value -1 indicates that the number of connections is not limited.

This parameter is unsupported. Please do not use it.

created_at

String

Specifies the time when the listener was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

default_pool_id

String

Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server.

default_tls_container_ref

String

Specifies the ID of the server certificate used by the listener.

description

String

Provides supplementary information about the listener.

http2_enable

Boolean

Specifies whether to use HTTP/2 if you want the clients to use HTTP/2 to communicate with the listener. However, connections between the load balancer and backend servers still use HTTP/1.x by default.

This parameter is available only for HTTPS listeners. If you configure this parameter for listeners with other protocols, it will not take effect.

id

String

Specifies the listener ID.

insert_headers

ListenerInsertHeaders object

Specifies the HTTP header fields that can transmit required information to backend servers. For example, the X-Forwarded-ELB-IP header field can transmit the EIP of the load balancer to backend servers.

loadbalancers

Array of LoadBalancerRef objects

Specifies the ID of the load balancer that the listener is added to. A listener can be added to only one load balancer.

name

String

Specifies the listener name.

project_id

String

Specifies the ID of the project where the listener is used.

protocol

String

Specifies the protocol used by the listener.

The value can be TCP, HTTP, UDP, HTTPS or TERMINATED_HTTPS.

Note:

  • Protocol used by HTTPS listeners added to a shared load balancer can only be set to TERMINATED_HTTPS. If HTTPS is passed, the value will be automatically changed to TERMINATED_HTTPS.

  • Protocol used by HTTPS listeners added to a dedicated load balancer can only be set to HTTPS. If TERMINATED_HTTPS is passed, the value will be automatically changed to HTTPS.

protocol_port

Integer

Specifies the port used by the listener to receive requests from clients.

Minimum: 1

Maximum: 65535

sni_container_refs

Array of strings

Specifies the IDs of SNI certificates (server certificates with domain names) used by the listener.

Note:

  • The domain names of all SNI certificates must be unique.

  • The total number of domain names of all SNI certificates cannot exceed 30.

sni_match_algo

String

Specifies how wildcard domain name matches with the SNI certificates used by the listener.

longest_suffix indicates longest suffix match. wildcard indicates wildcard match.

The default value is wildcard.

tags

Array of Tag objects

Lists the tags.

updated_at

String

Specifies the time when the listener was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

tls_ciphers_policy

String

Specifies the security policy used by the listener.

Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

Note:

  • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

  • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

  • The priority of the encryption suite from high to low is: ecc suite, rsa suite, tls 1.3 suite (supporting both ecc and rsa).

security_policy_id

String

Specifies the ID of the custom security policy.

Note:

  • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

  • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

  • The priority of the encryption suite from high to low is: ecc suite, rsa suite, tls 1.3 suite (supporting both ecc and rsa).

enable_member_retry

Boolean

Specifies whether to enable health check retries for backend servers. The value can be true (enable health check retries) or false (disable health check retries). The default value is true.

Note:

  • If a shared load balancer is associated, this parameter is available only when protocol is set to HTTP or TERMINATED_HTTPS.

  • If a dedicated load balancer is associated, this parameter is available only when protocol is set to HTTP or HTTPS.

keepalive_timeout

Integer

Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

  • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.

  • For HTTP and HTTPS listeners, the value ranges from 1 to 4000, and the default value is 60.

  • For UDP listeners, this parameter does not take effect.

client_timeout

Integer

Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

  • If the client fails to send a request header to the load balancer within the timeout duration, the request will be interrupted.

  • If the interval between two consecutive request bodies reaching the load balancer is greater than the timeout duration, the connection will be disconnected.

The value ranges from 1 to 300, and the default value is 60.

This parameter is available only for HTTP and HTTPS listeners.

member_timeout

Integer

Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

The value ranges from 1 to 300, and the default value is 60.

This parameter is available only for HTTP and HTTPS listeners.

ipgroup

ListenerIpGroup object

Specifies the IP address group associated with the listener.

transparent_client_ip_enable

Boolean

Specifies whether to pass source IP addresses of the clients to backend servers.

  • TCP or UDP listeners of shared load balancers: The value can be true or false, and the default value is false if this parameter is not passed.

  • HTTP or HTTPS listeners of shared load balancers: The value can only be true, and the default value is true if this parameter is not passed.

  • All listeners of dedicated load balancers: The value can only be true, and the default value is true if this parameter is not passed.

Note:

  • If this function is enabled, the load balancer communicates with backend servers using their real IP addresses. Ensure that security group rules and access control policies are correctly configured.

  • If this function is enabled, a server cannot serve as both a backend server and a client.

  • If this function is enabled, backend server specifications cannot be changed.

enhance_l7policy_enable

Boolean

Specifies whether to enable advanced forwarding. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.

  • If this function is enabled, action can be set to REDIRECT_TO_URL (requests will be redirected to another URL) or Fixed_RESPONSE (a fixed response body will be returned to clients).

  • Parameters priority, redirect_url_config, and fixed_response_config can be specified in a forwarding policy.

  • Parameter type can be set to METHOD, HEADER, QUERY_STRING, or SOURCE_IP for a forwarding rule .

  • If type is set to HOST_NAME for a forwarding rule, the value parameter of the forwarding rule supports wildcard asterisks (*).

  • The conditions parameter can be specified for forwarding rules.

Note

Value false can't be used after this parameter was set to true.

Default: false

quic_config

ListenerQuicConfig object

Specifies the QUIC configuration for the current listener. This parameter is valid only when protocol is set to HTTPS.

For a TCP/UDP/HTTP/QUIC listener, if this parameter is not left blank, an error will be reported.

Note

The client sends a normal HTTP request that contains information indicating that the QUIC protocol is supported.

If QUIC upgrade is enabled for the listeners, QUIC port and version information will be added to the response header.

When the client sends both HTTPS and QUIC requests to the server, if the QUIC request is successfully sent, QUIC protocol will be used for subsequent communications.

QUIC protocol is not supported.

Table 7 ListenerInsertHeaders

Parameter

Type

Description

X-Forwarded-ELB-IP

Boolean

Specifies whether to transparently transmit the load balancer EIP to backend servers. If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

Default: false

X-Forwarded-Port

Boolean

Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

Default: false

X-Forwarded-For-Port

Boolean

Specifies whether to transparently transmit the source port of the client to backend servers. If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

Default: false

X-Forwarded-Host

Boolean

Specifies whether to rewrite the X-Forwarded-Host header. If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

Default: true

Table 8 LoadBalancerRef

Parameter

Type

Description

id

String

Specifies the load balancer ID.

Table 9 Tag

Parameter

Type

Description

key

String

Specifies the tag key.

Minimum: 1

Maximum: 36

value

String

Specifies the tag value.

Minimum: 0

Maximum: 43

Table 10 ListenerIpGroup

Parameter

Type

Description

ipgroup_id

String

Specifies the ID of the IP address group associated with the listener.

This parameter is mandatory when you create the IP address group and is optional when you update the IP address group.

The specified IP address group must exist, and the value cannot be null.

enable_ipgroup

Boolean

Specifies whether to enable access control.

  • true: Access control is enabled.

  • false: Access control is disabled.

A listener with access control enabled can be directly deleted.

type

String

Specifies how access to the listener is controlled.

  • white: A whitelist is configured. Only IP addresses in the whitelist can access the listener.

  • black: A blacklist is configured. IP addresses in the blacklist are not allowed to access the listener.

Table 11 ListenerQuicConfig

Parameter

Type

Description

quic_listener_id

String

Specifies the ID of the QUIC listener. This parameter is mandatory for creation and is optional for update. The specified quic_listener_id must exist. The listener protocol must be QUIC and cannot be set to null, otherwise, it will conflict with enable_quic_upgrade.

QUIC protocol is not supported.

enable_quic_upgrade

Boolean

Specifies whether to enable QUIC upgrade. True: QUIC upgrade is enabled. False: QUIC upgrade is disabled. HTTPS listeners can be upgraded to QUIC listeners.

QUIC protocol is not supported.

Example Requests

Queries the listeners on each page

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners?limit=2&marker=0r31747a-b139-492f-2749-2df0b1c87193

Example Responses

Status code: 200

Successful request.

{
  "listeners" : [ {
    "id" : "0b11747a-b139-492f-9692-2df0b1c87193",
    "name" : "My listener",
    "protocol_port" : 80,
    "protocol" : "TCP",
    "ipgroup" : null,
    "description" : "My listener update.",
    "default_tls_container_ref" : null,
    "admin_state_up" : true,
    "loadbalancers" : [ {
      "id" : "098b2f68-af1c-41a9-8efd-69958722af62"
    } ],
    "member_timeout" : null,
    "client_timeout" : null,
    "keepalive_timeout" : 300,
    "client_ca_tls_container_ref" : null,
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "sni_container_refs" : [ ],
    "connection_limit" : -1,
    "default_pool_id" : null,
    "tls_ciphers_policy" : "tls-1-0",
    "tags" : [ ],
    "created_at" : "2019-04-02T00:12:32Z",
    "updated_at" : "2019-04-02T17:43:46Z",
    "http2_enable" : true,
    "insert_headers" : {
      "X-Forwarded-ELB-IP" : true
    },
    "transparent_client_ip_enable" : false,
    "quic_config" : null
  }, {
    "id" : "0b455839-3ea7-4bac-ad26-35bf22f96ea4",
    "name" : "listener-test",
    "protocol_port" : 86,
    "protocol" : "TERMINATED_HTTPS",
    "description" : null,
    "default_tls_container_ref" : "ad9b123e858d4652b80e89b9941e49a4",
    "admin_state_up" : true,
    "loadbalancers" : [ {
      "id" : "309a0f61-0b62-45f2-97d1-742f3434338e"
    } ],
    "member_timeout" : 60,
    "client_timeout" : 60,
    "keepalive_timeout" : 15,
    "client_ca_tls_container_ref" : "7875ccb4c6b44cdb90ab2ab89892ab71",
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "sni_container_refs" : [ "7f41c96223d34ebaa3c8e836b6625ec0" ],
    "connection_limit" : -1,
    "default_pool_id" : "5e7e0175-d5d5-4f37-bfba-88a9524ad20b",
    "tls_ciphers_policy" : "tls-1-0",
    "tags" : [ ],
    "created_at" : "2019-03-22T23:37:14Z",
    "updated_at" : "2019-03-22T23:37:14Z",
    "http2_enable" : false,
    "ipgroup" : null,
    "insert_headers" : {
      "X-Forwarded-ELB-IP" : true
    },
    "transparent_client_ip_enable" : false,
    "quic_config" : null
  } ],
  "page_info" : {
    "next_marker" : "0b455839-3ea7-4bac-ad26-35bf22f96ea4",
    "previous_marker" : "0b11747a-b139-492f-9692-2df0b1c87193",
    "current_count" : 2
  },
  "request_id" : "774640ee-6863-4de3-8156-aff16f51a087"
}

Status Codes

Status Code

Description

200

Successful request.

Error Codes

See Error Codes.

last updated: 2024-05-18 01:17