All Products
Search
Document Center

ENS:DescribeLoadBalancerListeners

Last Updated:Nov 18, 2024

Queries listeners of Edge Load Balancer (ELB) instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeLoadBalancerListenerslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LoadBalancerIdstringYes

The ID of the ELB instance.

lb-5s7crik3yo3p5****
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response.

RequestIdstring

The ID of the request.

F3B261DD-3858-4D3C-877D-303ADF374600
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The total number of entries.

49
Listenersarray<object>

The listeners of the ELB instance.

Listenerobject

The listener of the ELB instance.

LoadBalancerIdstring

The ID of the ELB instance.

lb-51a5fhou****
ListenerPortstring

The listening port.

8080
Protocolstring

The network transmission protocol that is used by the listener.

  • tcp
  • udp
  • http
  • https
tcp
Descriptionstring

The description of the listener.

test
Statusstring

The status of the listener. Valid values:

  • running
  • stopped
running
ListenerForwardstring

Indicates whether HTTP-to-HTTPS redirection is enabled for the listener. Valid values:

  • on
  • off
off
ForwardPortstring

The listener port that is used for HTTP-to-HTTPS redirection.

443
CreateTimestring

The timestamp when the listener was created.

2022-08-15T08:42:57Z

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400ens.interface.errorAn error occurred while call the API.
400LoadBalancerNotFoundThe input parameter loadBalancerId that is not found.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.