Atom feed of this document
 

 4.4.3. Modify Nodes

Verb URI Description
PUT /loadbalancers/loadBalancerId/nodes/nodeId Modify the configuration of a node on the load balancer.

Normal Response Code(s): 200, 202

Error Response Code(s): loadbalancerFault (400, 500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation does not require a request body.

[Note]Note

The node's IP and port are immutable attributes and cannot be modified with a PUT request. Supplying an unsupported attribute will result in a 400 (badRequest) fault. A load balancer supports a maximum of 25 nodes; the maximum weight of a node is 100.

Every node in the load balancer has an associated condition which determines its role within the load balancer.

The following table lists the required and optional attributes for Modify Nodes:

Table 4.7. Required and Optional Attributes for Modify Nodes
Name Description Required
condition Condition for the node, which determines its role within the load balancer. Refer to Section 4.4.3, “Modify Nodes” for a table of available node conditions. No
type

Type of node:

  • PRIMARY – Nodes defined as PRIMARY are in the normal rotation to receive traffic from the load balancer.

  • SECONDARY – Nodes defined as SECONDARY are only in the rotation to receive traffic from the load balancer when all the primary nodes fail. This provides a failover feature that automatically routes traffic to the secondary node in the event that the primary node is disabled or in a failing state. Note that active health monitoring must be enabled on the load balancer to enable the failover feature to the secondary node.

No
weight Weight of node. If the WEIGHTED_ROUND_ROBIN load balancer algorithm mode is selected, then the user should assign the relevant weight to the node using the weight attribute for the node. Must be an integer from 1 to 100. No
[Note]Note

At least one of the optional attributes is required for the Modify Nodes request.

Table 4.8. Load Balancer Node Conditions
Name Description
ENABLED Node is permitted to accept new connections.
DISABLED Node is not permitted to accept any new connections regardless of session persistence configuration. Existing connections are forcibly terminated.
DRAINING Node is allowed to service existing established connections and connections that are being directed to it as a result of the session persistence configuration.
 

Example 4.41. Modify Node Condition Request: XML

<node xmlns="http://docs.openstack.org/loadbalancers/api/v1.0" condition="ENABLED" weight="12"/>

                    

 

Example 4.42. Modify Node Condition Request: JSON

{"node":{
        "condition": "ENABLED",
        "weight": 59
    }
}

                    



loading table of contents...