All Products
Search
Document Center

ENS:DescribeLoadBalancerUDPListenerAttribute

Last Updated:Mar 12, 2024

Queries the configuration of a User Datagram Protocol (UDP) listener.

Operation description

  • You can call this operation up to 100 times per second per account.
  • You can call this operation up to 10 times per second per user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ListenerPortintegerYes

The frontend port that is used by the Edge Load Balance (ELB) instance. Valid values: 1 to 65535.

80
LoadBalancerIdstringYes

The ID of the ELB instance.

lb-5pzipr2fszqtl2xf64uy5****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

5D7597CF-1630-54EC-A945-624A33F2E7E8
ListenerPortinteger

The frontend port that is used by the ELB instance.

80
Statusstring

The status of the listener. Valid values:

  • Running
  • Stopped
  • Starting
  • Configuring
  • Stopping
Stopped
Bandwidthinteger

The maximum bandwidth of the elastic IP address (EIP).

  • Default value: 5.
  • Valid values: 5 to 10000.
  • Unit: Mbit/s.
5
Schedulerstring

The routing algorithm. Valid values:

  • wrr: Backend servers with higher weights receive more requests than those with lower weights.
  • wlc: Requests are distributed based on the weight and load of each backend server. The load refers to the number of connections to a backend server. If two backend servers have the same weight, the backend server that has fewer connections receives more requests.
  • rr: Requests are distributed to backend servers in sequence.
  • sch: consistent hashing that is based on source IP addresses. Requests from the same source IP address are distributed to the same backend server.
  • qch: consistent hashing that is based on QUIC connection IDs. Requests that contain the same QUIC connection ID are distributed to the same backend server.
  • iqch: consistent hashing that is based on specific three bytes of the iQUIC CIDs. Requests whose second to fourth bytes are the same are distributed to the same backend server.
wrr
HealthCheckstring

Specifies whether to enable the health check feature. Valid values:

  • on
  • off
on
HealthyThresholdinteger

The number of consecutive successful health checks that must occur before an unhealthy and inaccessible backend server is declared healthy and accessible. Valid values: 2 to 10.

Note This parameter takes effect only if you set HealthCheck to on.
4
UnhealthyThresholdinteger

The number of consecutive failed health checks that must occur before a healthy and accessible backend server is declared unhealthy and inaccessible. Valid values: 2 to 10.

Note This parameter takes effect only if you set HealthCheck to on.
4
HealthCheckConnectTimeoutinteger

The timeout period of a health check response. If a backend server does not respond within the specified timeout period, the server fails to pass the health check.

  • Default value: 5.
  • Valid values: 1 to 300.
  • Unit: seconds.
Note
  • This parameter takes effect only if you set HealthCheck to on.

  • If the value of the HealthCheckConnectTimeout parameter is smaller than that of the HealthCheckInterval parameter, the timeout period specified by the HealthCheckConnectTimeout parameter becomes invalid and the value of the HealthCheckInterval parameter is used as the timeout period.

100
HealthCheckIntervalinteger

The interval at which health checks are performed. Valid values: 1 to 50. Unit: seconds.

Note This parameter takes effect only if you set HealthCheck to on.
5
Descriptionstring

The description of the listener.

example
BackendServerPortinteger

The backend port that is used by the ELB instance. Valid values: 1 to 65535.

8080
HealthCheckConnectPortinteger

The port that is used for health checks. Valid values: 1 to 65535. If you leave this parameter empty, the port specified by BackendServerPort is used for health checks.

8000
HealthCheckReqstring

The request string for UDP listener health checks. The string can be up to 64 characters in length and can contain only letters and digits.

hello
HealthCheckExpstring

The response string for UDP listener health checks. The string can be up to 64 characters in length and can contain only letters and digits.

ok
EipTransmitstring

Indicates whether EIP pass-through is enabled. Valid values:

  • on
  • off (default)
on

Examples

Sample success responses

JSONformat

{
  "RequestId": "5D7597CF-1630-54EC-A945-624A33F2E7E8",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": 5,
  "Scheduler": "wrr",
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "HealthCheckReq": "hello",
  "HealthCheckExp": "ok",
  "EipTransmit": "on"
}

Error codes

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

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

Change history

Change timeSummary of changesOperation
No change history