nodebalancers

Overview

Name	nodebalancers
Type	Resource
Id	linode.nodebalancers.nodebalancers

Fields

Name	Datatype	Description
id	integer	This NodeBalancer's unique ID.
client_conn_throttle	integer	Throttle connections per second. Set to 0 (zero) to disable throttling.
created	string	When this NodeBalancer was created.
hostname	string	This NodeBalancer's hostname, beginning with its IP address and ending with .ip.linodeusercontent.com.
ipv4	string	This NodeBalancer's public IPv4 address.
ipv6	string	This NodeBalancer's public IPv6 address.
label	string	This NodeBalancer's label. These must be unique on your Account.
region	string	The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.
tags	array	An array of Tags applied to this object. Tags are for organizational purposes only.
transfer	object	Information about the amount of transfer this NodeBalancer has had so far this month.
updated	string	When this NodeBalancer was last updated.

Methods

Name	Accessible by	Required Params	Description
getNodeBalancer	SELECT	nodeBalancerId	Returns a single NodeBalancer you can access.
getNodeBalancers	SELECT		Returns a paginated list of NodeBalancers you have access to.
createNodeBalancer	INSERT	data__region	Creates a NodeBalancer in the requested Region. NodeBalancers require a port Config with at least one backend Node to start serving requests. When using the Linode CLI to create a NodeBalancer, first create a NodeBalancer without any Configs. Then, create Configs and Nodes for that NodeBalancer with the respective Config Create and Node Create commands.
deleteNodeBalancer	DELETE	nodeBalancerId	Deletes a NodeBalancer. This is a destructive action and cannot be undone. Deleting a NodeBalancer will also delete all associated Configs and Nodes, although the backend servers represented by the Nodes will not be changed or removed. Deleting a NodeBalancer will cause you to lose access to the IP Addresses assigned to this NodeBalancer.
_getNodeBalancer	EXEC	nodeBalancerId	Returns a single NodeBalancer you can access.
_getNodeBalancers	EXEC		Returns a paginated list of NodeBalancers you have access to.
updateNodeBalancer	EXEC	nodeBalancerId	Updates information about a NodeBalancer you can access.