Get a NodeBalancer

get

https://api.linode.com/{apiVersion}/nodebalancers/{nodeBalancerId}

Returns a single NodeBalancer you can access. Run the List VPC configurations operation to get the NodeBalancer's VPC configuration.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

Identity and access permissions. Your user needs a role with these permissions. Learn more.
- Permissions: view_nodebalancer
OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: nodebalancers:read_only

CLI

linode-cli nodebalancers view 12345

Learn more

Responses

Response body

object

client_conn_throttle

integer

0 to 20

Throttle TCP connections per second for TCP, HTTP, and HTTPS configurations. Set to 0 (zero) to disable throttling.

created

date-time

Read-only When this NodeBalancer was created.

hostname

string

Read-only This NodeBalancer's hostname, beginning with its IP address and ending with .ip.linodeusercontent.com.

integer

Read-only This NodeBalancer's unique ID.

ipv4

string

Filterable, Read-only This NodeBalancer's public IPv4 address.

ipv6

string | null

Read-only This NodeBalancer's public IPv6 address.

label

string

length between 3 and 32

Filterable This NodeBalancer's label. These must be unique on your Account.

lke_cluster

object | null

Read-only This NodeBalancer's related LKE cluster, if any. The value is null if this NodeBalancer isn't related to an LKE cluster.

string

The ID of the related LKE cluster.

label

string

The label of the related LKE cluster.

type

string

Read-only The type for LKE clusters.

url

string

The URL where you can access the related LKE cluster.

locks

array of strings | null

Beta, Filterable, Read-only Indicates if this NodeBalancer is protected by a lock to prevent accidental deletion. If the NodeBalancer has a cannot_delete lock, it can't be deleted, but its configurations and backend nodes can. If the NodeBalancer has a cannot_delete_with_subresources lock, both the NodeBalancer and attached resources such as configurations and backend nodes can't be deleted. Only account administrators can remove locks using the Delete a resource lock operation.

locks

region

string

Filterable, Read-only The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.

tags

transfer

object

Read-only Information about the amount of transfer this NodeBalancer has had so far this month.

number | null

Read-only The total outbound transfer, in MB, used for this NodeBalancer this month.

out

number | null

Read-only The total inbound transfer, in MB, used for this NodeBalancer this month.

total

number | null

Read-only The total transfer, in MB, used by this NodeBalancer this month.

type

string

enum

Read-only The type of NodeBalancer.

common premium

updated

date-time

Read-only When this NodeBalancer was last updated.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.linode.com/v4/nodebalancers/nodeBalancerId \
3
     --header 'accept: application/json'


xxxxxxxxxx
28
 
1
{
2
  "client_conn_throttle": 10,
3
  "created": "2018-01-01T00:01:01",
4
  "hostname": "192.0.2.1.ip.linodeusercontent.com",
5
  "id": 12345,
6
  "ipv4": "203.0.113.1",
7
  "ipv6": null,
8
  "label": "balancer12345",
9
  "lke_cluster": {
10
    "id": 12345,
11
    "label": "lkecluster12345",
12
    "type": "lkecluster",
13
    "url": "/v4/lke/clusters/12345"
14
  },
15
  "locks": "cannot_delete",
16
  "region": "us-east",
17
  "tags": [
18
    "example tag",
19
    "another example"
20
  ],
21
  "transfer": {
22
    "in": 28.91200828552246,
23
    "out": 3.5487728118896484,
24
    "total": 32.46078109741211
25
  },
26
  "type": "premium",
27
  "updated": "2018-03-01T00:01:01"
28
}

200The requested NodeBalancer object.

defaultSee Errors for the range of possible error response codes.