DescribeLoadBalancerUDPListenerAttribute - Server Load Balancer

Queries the configuration of a UDP 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

slb:DescribeLoadBalancerUDPListenerAttribute

get

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the Server Load Balancer instance.	cn-hangzhou
LoadBalancerId	string	Yes	The ID of the Classic Load Balancer instance.	lb-bp1rtfnodmywb43e*****
ListenerPort	integer	Yes	The frontend port used by the Classic Load Balancer instance. Valid values: 1 to 65535.	80

Response elements

Element	Type	Description	Example
	object
VServerGroupId	string	The ID of the vServer group attached to the listener.	rsp-cige6j****
Status	string	The current status of the listener. Valid values: running: The listener is running normally. stopped: The listener is stopped.	stopped
AclType	string	The access control type: white: Only requests from IP addresses or CIDR blocks in the selected access control policy group are forwarded. Use this setting when your application allows only specific IP addresses. Using a whitelist carries business risk. After you enable a whitelist, only IP addresses in the list can access the SLB listener. If you enable a whitelist but do not add any IP addresses to the policy group, the SLB listener forwards all requests. black: Requests from IP addresses or CIDR blocks in the selected access control policy group are blocked. Use this setting when your application restricts access for specific IP addresses. If you enable a blacklist but do not add any IP addresses to the policy group, the SLB listener forwards all requests.	white
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710
HealthCheckConnectPort	integer	The port used for health checks. Valid values: 1 to 65535. If you do not specify this parameter, the backend server port (BackendServerPort) is used. Note This parameter takes effect only when HealthCheck is set to on.	8080
Description	string	A custom name for the listener.	UDP_80
Bandwidth	integer	The maximum bandwidth for the listener, in Mbit/s. Valid values: -1: For Internet-facing SLB instances that use pay-by-data-transfer billing, set the maximum bandwidth to -1 to remove the bandwidth limit. 1 to 5120: For Internet-facing SLB instances that use pay-by-bandwidth billing, set the maximum bandwidth for each listener. The sum of all listener bandwidth limits must not exceed the instance's maximum bandwidth.	-1
MasterSlaveServerGroupId	string	The ID of the primary/secondary server group attached to the listener.	rsp-0bfucw****
BackendServerPort	integer	The backend port used by the Classic Load Balancer instance. Note This parameter is not returned if the backend server group is a vServer group.	90
AclStatus	string	Whether access control is enabled. Valid values: on or off (default).	off
UnhealthyThreshold	integer	The unhealthy threshold. The number of consecutive failed health checks before the health check status of a backend server changes from success to failure. Valid values: 2 to 10.	4
ProxyProtocolV2Enabled	boolean	Whether the Proxy Protocol version 2 is enabled to pass client source IP addresses to backend servers. Valid values: true: Yes. false: No.	false
ListenerPort	integer	The frontend port used by the Classic Load Balancer instance.	53
HealthCheckInterval	integer	The interval between health checks, in seconds. Valid values: 1 to 50.	5
HealthCheckExp	string	The response string for UDP listener health checks. This string can contain only letters and digits. Maximum length: 64 characters.	ok
AclId	string	The ID of the access control policy group.	acl-uf60jwfiv6******
Scheduler	string	The scheduling algorithm. Valid values: wrr (default): Backend servers with higher weights receive more requests. rr: Requests are distributed to backend servers in sequence.	wrr
HealthCheckConnectTimeout	integer	The time to wait for a response from a health check. If an ECS instance does not respond within this time, the health check fails. Valid values: 1 to 300 seconds.	100
HealthyThreshold	integer	The healthy threshold. The number of consecutive successful health checks before the health check status of a backend server changes from failure to success. Valid values: 2 to 10.	4
HealthCheckReq	string	The request string for UDP listener health checks. This string can contain only letters and digits. Maximum length: 64 characters.	hello
HealthCheck	string	Whether health checks are enabled. Valid values: on: Enabled. off: Disabled.	on
AclIds	object
AclId	array	The ID of the access control policy group.

LoadBalancerId	string	The ID of the Classic Load Balancer instance.	lb-bp1rtfnodmywb43e*****
Tags	object
Tag	array<object>	The list of tags.
	object	The list of tags.
TagKey	string	The tag key for the listener. Valid values for N: 1 to 20. You cannot specify an empty string. Maximum length: 128 characters. It cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	TestKey
TagValue	string	The tag value for the listener. Valid values for N: 1 to 20. You can specify an empty string. Maximum length: 128 characters. It cannot start with `acs:`. It cannot contain `http://` or `https://`.	TestValue

Examples

Success response

JSON format

{
  "VServerGroupId": "rsp-cige6j****",
  "Status": "stopped",
  "AclType": "white",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "HealthCheckConnectPort": 8080,
  "Description": "UDP_80",
  "Bandwidth": -1,
  "MasterSlaveServerGroupId": "rsp-0bfucw****",
  "BackendServerPort": 90,
  "AclStatus": "off",
  "UnhealthyThreshold": 4,
  "ProxyProtocolV2Enabled": false,
  "ListenerPort": 53,
  "HealthCheckInterval": 5,
  "HealthCheckExp": "ok",
  "AclId": "acl-uf60jwfiv6******",
  "Scheduler": "wrr",
  "HealthCheckConnectTimeout": 100,
  "HealthyThreshold": 4,
  "HealthCheckReq": "hello",
  "HealthCheck": "on",
  "AclIds": {
    "AclId": [
      ""
    ]
  },
  "LoadBalancerId": "lb-bp1rtfnodmywb43e*****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "TestKey",
        "TagValue": "TestValue"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.