All Products
Search

This Product

    Server Load Balancer:UpdateListenerAttribute

    Document Center

    Server Load Balancer:UpdateListenerAttribute

    Last Updated:Dec 02, 2024

    Updates the configurations of a Gateway Load Balancer (GWLB) listener.

    Operation description

    UpdateListenerAttribute is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetListenerAttribute operation to query the status of a listener.

    • If the listener is in the Configuring state, the listener is being modified.
    • If the listener is in the Running state, the listener is modified.

    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
    gwlb:UpdateListenerAttributeupdate
    *LoadBalancer
    acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
    *Listener
    acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}
    *ServerGroup
    acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ListenerIdstringYes

    The listener ID.

    		lsn-lxce8iqbof2vl0****
    ListenerDescriptionstringNo

    The listener description.

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

    		listener_description
    ServerGroupIdstringNo

    The server group ID.

    		sgp-sp8d2r6y7t0xtl****
    DryRunbooleanNo

    Specifies whether to perform a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		false
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.

    		123e4567-e89b-12d3-a456-42665544****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		7DBFC67C-A272-5952-8287-6C3EBE4E04D9

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IncorrectBusinessStatus.LoadBalancerThe business status of %s [%s] is incorrect.Resource %s with business state %s does not support current operation
    400IncorrectStatus.LoadBalancerThe status of %s [%s] is incorrect.Resource %s current state %s does not support operation
    400IncorrectStatus.ListenerThe status of %s [%s] is incorrect.Operation not supported for resource% s in current state% s.
    400Mismatch.VpcIdThe %s is mismatched for %s and %s.The VPC IDs of the two resources do not match.
    400ResourceInUse.IPThe specified resource of IP is in use.-
    400IncorrectStatus.ServerGroupThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
    404ResourceNotFound.LoadBalancerThe specified resource of %s is not found.The specified resource of .LoadBalancer is not found.
    404ResourceNotFound.ListenerThe specified resource of %s is not found.The specified resource of %s is not found.
    404ResourceNotFound.ServerGroupThe specified resource of %s is not found.The specified server group resource does not exist.

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