All Products
Search

This Product

    ENS:DescribeLoadBalancerUDPListenerAttribute

    Document Center

    ENS:DescribeLoadBalancerUDPListenerAttribute

    Last Updated:Dec 25, 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

    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:DescribeLoadBalancerUDPListenerAttributeget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ListenerPortintegerYes

    The listening port that you want to query. 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 listener port.

    		80
    Statusstring

    The status of the listener. Valid values:

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

    The peak bandwidth of the Edge Load Balancer (ELB) instance. The default value is -1, which indicates that the bandwidth is not limited.

    		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 for a health check response. If a backend server does not respond within the specified timeout period, the server fails the health check.

    • Default value: 5.
    • Valid values: 1 to 300.
    • Unit: seconds.
    Note

    • This parameter takes effect only if the HealthCheck parameter is set to on.

    • If the value of the HealthCheckTimeout property is smaller than the value of the HealthCheckInterval property, the timeout period specified by the HealthCheckTimeout property becomes invalid and the value of the HealthCheckInterval property 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 name of the listener.

    		example
    BackendServerPortinteger

    The port used by the backend ELB server of 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
    EstablishedTimeoutinteger

    The timeout period of a connection. Valid values: 10 to 900. Unit: seconds.

    		500

    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",
  "EstablishedTimeout": 500
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ListenerNotFoundListener is not found.Listener does not exist
    400LoadBalancerNotFoundThe input parameter LoadBalancerId that is not found.The load balancing instance does not exist.
    400ens.interface.errorFailed to call 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
    2024-08-20The Error code has changed. The response structure of the API has changedView Change Details
    2024-06-04The Error code has changedView Change Details