Filter ELB Listeners by Port via DescribeLoadBalancerListeners - ENS

Queries listeners of Edge Load Balancer (ELB) instances.

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

ens:DescribeLoadBalancerListeners

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the ELB instance.	lb-5s7crik3yo3p5****
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
ListenerPort	integer	No	The listener port.	80
Description	string	No	The description of the image.	test

Response elements

Element	Type	Description	Example
	object	Schema of Response.
RequestId	string	The ID of the request.	F3B261DD-3858-4D3C-877D-303ADF374600
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	49
Listeners	object
Listener	array<object>	The listeners of the ELB instance.
	object	The listener of the ELB instance.
LoadBalancerId	string	The ID of the ELB instance.	lb-51a5fhou****
ListenerPort	string	The listening port.	8080
Protocol	string	The network transmission protocol that is used by the listener. tcp udp http https	tcp
Description	string	The description of the listener.	test
Status	string	The status of the listener. Valid values: running stopped	running
ListenerForward	string	Indicates whether HTTP-to-HTTPS redirection is enabled for the listener. Valid values: on off	off
ForwardPort	string	The listener port that is used for HTTP-to-HTTPS redirection.	443
CreateTime	string	The timestamp when the listener was created.	2022-08-15T08:42:57Z
BackendServerPort	integer	The backend port that is used by the ELB instance. Valid values: 1 to 65535.	3306

Examples

Success response

JSON format

{
  "RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 49,
  "Listeners": {
    "Listener": [
      {
        "LoadBalancerId": "lb-51a5fhou****",
        "ListenerPort": "8080",
        "Protocol": "tcp",
        "Description": "test",
        "Status": "running",
        "ListenerForward": "off",
        "ForwardPort": "443",
        "CreateTime": "2022-08-15T08:42:57Z",
        "BackendServerPort": 3306
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ens.interface.error	Failed to call API.
400	LoadBalancerNotFound	The input parameter LoadBalancerId that is not found.	The load balancing instance does not exist.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.