Skip to main content

configs_nodes

Overview

Nameconfigs_nodes
TypeResource
Idlinode.nodebalancers.configs_nodes

Fields

NameDatatypeDescription
idintegerThis node's unique ID.
addressstringThe private IP Address where this backend can be reached. This must be a private IP address.
config_idintegerThe NodeBalancer Config ID that this Node belongs to.
labelstringThe label for this node. This is for display purposes only.
modestringThe mode this NodeBalancer should use when sending traffic to this backend.
If set to accept this backend is accepting traffic.
If set to reject this backend will not receive traffic.
If set to drain this backend will not receive new traffic, but connections already
pinned to it will continue to be routed to it.

If set to backup, this backend will only receive traffic if all accept nodes
are down.
nodebalancer_idintegerThe NodeBalancer ID that this Node belongs to.
statusstringThe current status of this node, based on the configured checks of its NodeBalancer Config.
weightintegerUsed when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic.

Methods

NameAccessible byRequired ParamsDescription
getNodeBalancerConfigNodesSELECTconfigId, nodeBalancerIdReturns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port.
getNodeBalancerNodeSELECTconfigId, nodeBalancerId, nodeIdReturns information about a single Node, a backend for this NodeBalancer's configured port.
createNodeBalancerNodeINSERTconfigId, nodeBalancerId, data__address, data__labelCreates a NodeBalancer Node, a backend that can accept traffic for this NodeBalancer Config. Nodes are routed requests on the configured port based on their status.
deleteNodeBalancerConfigNodeDELETEconfigId, nodeBalancerId, nodeIdDeletes a Node from this Config. This backend will no longer receive traffic for the configured port of this NodeBalancer.

This does not change or remove the Linode whose address was used in the creation of this Node.
_getNodeBalancerConfigNodesEXECconfigId, nodeBalancerIdReturns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port.
_getNodeBalancerNodeEXECconfigId, nodeBalancerId, nodeIdReturns information about a single Node, a backend for this NodeBalancer's configured port.
updateNodeBalancerNodeEXECconfigId, nodeBalancerId, nodeIdUpdates information about a Node, a backend for this NodeBalancer's configured port.