All Products
Search
Document Center

Server Load Balancer:UpdateListenerAttribute

Last Updated:Mar 21, 2025

Updates the attributes of a listener, such as the name and the idle connection timeout period.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
nlb:UpdateListenerAttributeupdate
*LoadBalancer
acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ListenerIdstringYes

The listener ID.

lsn-bp1bpn0kn908w4nbw****@443
ListenerDescriptionstringNo

The name of the listener.

The name must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).

tcpssl_443
ServerGroupIdstringNo

The server group ID.

Note
  • If the listener uses TCP, you can specify server groups whose protocol is TCP or TCP_UDP. UDP server groups are not supported.

  • If the listener uses UDP, you can specify server groups whose protocol is UDP or TCP_UDP. TCP server groups are not supported.

  • If the listener uses TCPSSL, you can specify server groups whose protocol is TCP and whose client IP preservation is disabled. TCP server groups for which client IP preservation is enabled and server groups whose protocol is UDP or TCP_UDP are not supported.

sgp-ppdpc14gdm3x4o****
SecurityPolicyIdstringNo

The ID of the security policy.

Note This parameter takes effect only for listeners that use SSL over TCP.
tls_cipher_policy_1_1
CertificateIdsarrayNo

The server certificate. Only one server certificate is supported.

Note This parameter takes effect only for listeners that use SSL over TCP.
CertificateIdstringNo

The server certificate. Only one server certificate is supported.

Note This parameter takes effect only for listeners that use SSL over TCP.
12315790212_166f8204689_1714763408_70998****
CaCertificateIdsarrayNo

The CA certificate. You can specify only one CA certificate.

Note This parameter takes effect only for listeners that use SSL over TCP.
CaCertificateIdstringNo

The CA certificate. You can specify only one CA certificate.

Note This parameter takes effect only for listeners that use SSL over TCP.
139a00604ad-cn-east-hangzh****
CaEnabledbooleanNo

Specifies whether to enable mutual authentication. Valid values:

  • true
  • false
false
IdleTimeoutintegerNo

The timeout period for idle connections. Unit: seconds

  • If the listener uses TCP or TCPSSL, you can set this parameter to a value ranging from 10 to 900. Default value: 900
  • If the listener uses UDP, you can set this parameter to a value ranging from 10 to 20. Default value: 20
900
DryRunbooleanNo

Specifies whether to perform a dry run. Valid values:

  • true: validates the request without performing the operation. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the validation, the corresponding error message is returned. If the request passes the validation, the DryRunOperation error code is returned.
  • false (default): validates the request and performs the operation. If the request passes the validation, a 2xx HTTP status code is returned and the operation is performed.
false
ClientTokenstringNo

The client token used to ensure the idempotence of the request.

You can use the client to generate the token. Ensure that the token is unique among different requests. Only ASCII characters are allowed.

Note If you do not set this parameter, the value of RequestId is used.**** The value of RequestId is different for each request.
123e4567-e89b-12d3-a456-426655440000
RegionIdstringNo

The ID of the region where the NLB instance is deployed.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ProxyProtocolEnabledbooleanNo

Specifies whether to use the Proxy protocol to pass the client IP address to the backend server. Valid values:

  • true
  • false
false
SecSensorEnabledbooleanNo

Specifies whether to enable fine-grained monitoring. Valid values:

  • true
  • false
false
AlpnEnabledbooleanNo

Specifies whether to enable Application-Layer Protocol Negotiation (ALPN). Valid values:

  • true
  • false
false
AlpnPolicystringNo

The ALPN policy. Valid values:

  • HTTP1Only: uses only HTTP 1.x. The priority of HTTP 1.1 is higher than the priority of HTTP 1.0.
  • HTTP2Only: uses only HTTP 2.0.
  • HTTP2Optional: preferentially uses HTTP 1.x over HTTP 2.0. The priority of HTTP 1.1 is higher than the priority of HTTP 1.0, and the priority of HTTP 1.0 is higher than the priority of HTTP 2.0.
  • HTTP2Preferred: preferentially uses HTTP 2.0 over HTTP 1.x. The priority of HTTP 2.0 is higher than the priority of HTTP 1.1, and the priority of HTTP 1.1 is higher than the priority of HTTP 1.0.
Note This parameter is required if AlpnEnabled is set to true.
HTTP1Only
CpsintegerNo

The maximum number of new connections per second supported by the listener in each zone (virtual IP address). Valid values: 0 to 1000000. 0 indicates that the number of connections is unlimited.

10000
MssintegerNo

The size of the largest TCP packet segment. Unit: bytes. Valid values: 0 to 1500. 0 indicates that the maximum segment size (MSS) remains unchanged. This parameter is supported only by TCP listeners and listeners that use SSL over TCP.

344
ProxyProtocolV2ConfigobjectNo

Specifies that the Proxy protocol passes the VpcId, PrivateLinkEpId, and PrivateLinkEpsId parameters to backend servers.

Ppv2VpcIdEnabledbooleanNo

Specifies whether to use the Proxy protocol to pass the VpcId parameter to backend servers. Valid values:

  • true
  • false
false
Ppv2PrivateLinkEpIdEnabledbooleanNo

Specifies whether to use the Proxy protocol to pass the PrivateLinkEpId parameter to backend servers. Valid values:

  • true
  • false
false
Ppv2PrivateLinkEpsIdEnabledbooleanNo

Specifies whether to use the Proxy protocol to pass the PrivateLinkEpsId parameter to backend servers. Valid values:

  • true
  • false
false

Response parameters

ParameterTypeDescriptionExample
object

Updates listener configurations.

RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
JobIdstring

The ID of the asynchronous task.

72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

Error codes

HTTP status codeError codeError messageDescription
400Mismatch.VpcIdThe VpcId is mismatched for %s and %s.The VpcId is mismatched for %s and %s.
400Conflict.PortThe Port [%s] is conflict.The specified port conflicts with an existing port
400ResourceNotFound.CertificateThe specified resource %s is not found.-
400IncorrectStatus.listenerThe status of listener [%s] is incorrect.The current operation cannot be performed on the listener as its status is unavailable. Please check if the listener is currently undergoing any other operations.
400IdempotenceSignatureMismatchThe idempotence token of request is same with the prev one, but the signature is different.The requested idempotent token is the same as the previous one, but the signature is different.
400DryRunOperationRequest validation has been passed with DryRun flag set.Request validation has been passed with DryRun flag set.
400ResourceAlreadyAssociated.CertificateThe specified resource %s is already associated.-
400IllegalParamSize.certificateIdsThe param size of certificateIds or caCertificateIds is illegal.you can only have one certificate id. check whether the id is entered repeatedly.
400SystemBusySystem is busy, please try again later.-
400IllegalParam.IdleTimeoutThe param of IdleTimeout is illegal.The parameter connection idle timeout configuration is invalid.
400OperationDenied.RegionNotSupportHDMonitorThe operation is not allowed because of RegionNotSupportHDMonitor.The current region does not support second-level monitoring.
400ResourceNotEnough.CaCertificateApiCountThe specified resource of CaCertificateApiCount is not enough.-
400IllegalParamThe param of %s is illegal.-
403Forbidden.NoPermissionAuthentication is failed for NoPermission.Authentication is failed for NoPermission.
404ResourceNotFound.listenerThe specified resource %s is not found.-
404ResourceNotFound.HdMonitorConfigNotExistThe specified resource of HdMonitorConfigNotExist is not found.HdMonitorConfig does not exist, check the input parameters.
404ResourceNotFound.CaCertificateThe specified resource of CaCertificate is not found.Ca certificate does not exist, please check the input parameters.
404ResourceNotFound.securitypolicyThe specified resource of securitypolicy is not found.-

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

Change history

Change timeSummary of changesOperation
2025-02-14The Error code has changedView Change Details
2024-08-27The Error code has changedView Change Details
2024-02-29The Error code has changedView Change Details
2024-02-22The Error code has changedView Change Details
2024-02-04The Error code has changedView Change Details
2024-01-30The Error code has changedView Change Details
2024-01-29The Error code has changedView Change Details
2024-01-24The Error code has changedView Change Details
2023-12-18The Error code has changedView Change Details
2023-11-27The Error code has changed. The request parameters of the API has changedView Change Details
2023-09-26The Error code has changedView Change Details
2023-09-05The Error code has changedView Change Details
2023-08-22The Error code has changedView Change Details
2023-04-04The internal configuration of the API is changed, but the call is not affectedView Change Details