Modifies the configurations of a UDP listener.
Operation description
- You can call this operation up to 100 times per second.
- You can call this operation up to 10 times per second per account.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ens:SetLoadBalancerUDPListenerAttribute | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| LoadBalancerId | string | Yes | The ID of the Edge Load Balancer (ELB) instance. | lb-5pzipr2fszqtl2xf64uy5**** |
| ListenerPort | integer | Yes | The listener port whose attributes are to be modified. Valid values: 1 to 65535. | 80 |
| Description | string | No | The name of the listener. The valuemust be 1 to 80 characters in length. Note
The value cannot start with http:// or https://.
| example |
| Scheduler | string | No | The routing algorithm. Valid values:
| wrr |
| HealthyThreshold | integer | No | 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. | 4 |
| UnhealthyThreshold | integer | No | 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. | 4 |
| HealthCheckConnectTimeout | integer | No | The timeout period of a health check response. If the backend ENS does not respond within the specified time, the health check fails.
Note
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 |
| HealthCheckInterval | integer | No | The interval at which health checks are performed. Valid values: 1 to 50. Unit: seconds. | 5 |
| HealthCheckConnectPort | integer | No | The port that is used for health checks. Valid values: 1 to 65535. If you leave this parameter empty, the port specified for BackendServerPort is used for health checks. | 8080 |
| HealthCheckReq | string | No | 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 |
| HealthCheckExp | string | No | 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 |
| EipTransmit | string | No | Specifies whether to enable Elastic IP address (EIP) pass-through. Valid values:
| on |
| EstablishedTimeout | integer | No | The timeout period of a connection. Valid values: 10 to 900. Default value: 900. Unit: seconds. | 500 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "06F00FBB-3D9E-4CCE-9D43-1A6946A75456"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Invalid%s | The specified parameter %s is invalid. | - |
| 400 | Missing%s | You must specify the parameter %s. | - |
| 400 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | The current operation is not supported. The disk is being reset. |
| 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 | IncorrectListenerStatus | The current status of the resource does not support this operation. | The listener status is incorrect. |
| 400 | ListenerNotFound | Listener is not found. | Listener does not exist |
| 400 | NoPermission | Permission denied. | - |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-08-20 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2024-01-22 | The API operation is not deprecated.. The Error code has changed | View Change Details |