node_balancers
Creates, updates, deletes, gets or lists a node_balancers resource.
Overview
| Name | node_balancers |
| Type | Resource |
| Id | linode.linode.node_balancers |
Fields
The following fields are returned by SELECT queries:
- list
Returns a paginated list of NodeBalancers.
| Name | Datatype | Description |
|---|---|---|
id | integer | Read-only This NodeBalancer's unique ID. |
client_conn_throttle | integer | Throttle TCP connections per second for TCP, HTTP, and HTTPS configurations. Set to 0 (zero) to disable throttling. |
created | string (date-time) | Read-only When this NodeBalancer was created. (example: 2018-01-01T00:01:01) |
hostname | string | Read-only This NodeBalancer's hostname, beginning with its IP address and ending with .ip.linodeusercontent.com. (example: 192.0.2.1.ip.linodeusercontent.com) |
ipv4 | string (ip) | Filterable, Read-only This NodeBalancer's public IPv4 address. (example: 203.0.113.1) |
ipv6 | string (ip) | Read-only This NodeBalancer's public IPv6 address. |
label | string | Filterable This NodeBalancer's label. These must be unique on your Account. (example: balancer12345, pattern: [a-zA-Z0-9-_]{3,32}) |
lke_cluster | object | Read-only This NodeBalancer's related LKE cluster, if any. The value is null if this NodeBalancer isn't related to an LKE cluster. |
region | string | Filterable, Read-only The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region. (example: us-east) |
tags | array | Filterable An array of Tags applied to this object. Tags are for organizational purposes only. |
transfer | object | Read-only Information about the amount of transfer this NodeBalancer has had so far this month. |
type | string | Read-only The type of NodeBalancer. (common, premium) (example: premium) |
updated | string (date-time) | Read-only When this NodeBalancer was last updated. (example: 2018-03-01T00:01:01) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | linodeId | Returns a list of NodeBalancers that are assigned to this Linode and readable by the requesting User. Read permission to a NodeBalancer can be given to a User by accessing the Update a user's grants operation. Learn more... Learn more... |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
linodeId | string | ID of the Linode to look up. |
SELECT examples
- list
Returns a list of NodeBalancers that are assigned to this Linode and readable by the requesting User.
Read permission to a NodeBalancer can be given to a User by accessing the Update a user's grants operation.
Learn more...
Learn more...
SELECT
id,
client_conn_throttle,
created,
hostname,
ipv4,
ipv6,
label,
lke_cluster,
region,
tags,
transfer,
type,
updated
FROM linode.linode.node_balancers
WHERE linodeId = '{{ linodeId }}' -- required
;