Linode Kubernetes Engine (LKE)
Node Pools List
https://api.linode.com/v4/lke/clusters/{clusterId}/poolsReturns all active Node Pools on a Kubernetes cluster.
Path Parameters
ID of the Kubernetes cluster to look up.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/lke/clusters/12345/pools
Response Samples
- 200
- default
{
"data": [
{
"id": "",
"type": "g6-standard-4",
"tags": [
"example tag",
"another example"
],
"autoscaler": {
"enabled": true,
"max": 12,
"min": 3
},
"count": 6,
"disks": [],
"nodes": []
}
],
"page": 1,
"pages": 1,
"results": 1
}Responses
200: Returns an array of all Pools in this Kubernetes cluster.
This Node Pool's unique ID.
The Linode Type for all of the nodes in the Node Pool.
An array of tags applied to this object. Tags are for organizational purposes only.
When enabled, the number of nodes autoscales within the defined minimum and maximum values.
Whether autoscaling is enabled for this Node Pool. Defaults to false.
The maximum number of nodes to autoscale to. Defaults to the Node Pool's count.
The minimum number of nodes to autoscale to. Defaults to the Node Pool's count.
The number of nodes in the Node Pool.
This Node Pool's custom disk layout.
Status information for the Nodes which are members of this Node Pool. If a Linode has not been provisioned for a given Node slot, the instance_id will be returned as null.
The current page.
The total number of pages.
The total number of results.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.
Node Pool Create
https://api.linode.com/v4/lke/clusters/{clusterId}/poolsCreates a new Node Pool for the designated Kubernetes cluster.
Path Parameters
ID of the Kubernetes cluster to look up.
Request Body Schema
The number of nodes in the Node Pool.
The Linode Type for all of the nodes in the Node Pool.
When enabled, the number of nodes autoscales within the defined minimum and maximum values.
When making a request, max and min require each other.
Whether autoscaling is enabled for this Node Pool. Defaults to false.
The maximum number of nodes to autoscale to. Defaults to the Node Pool's count. Defaults to the value provided by the count field.
The minimum number of nodes to autoscale to. Defaults to the Node Pool's count.
Note: This field should be omitted except for special use cases. The disks specified here are partitions in addition to the primary partition and reduce the size of the primary partition, which can lead to stability problems for the Node.
This Node Pool's custom disk layout. Each item in this array will create a new disk partition for each node in this Node Pool.
- The custom disk layout is applied to each node in this Node Pool.
- The maximum number of custom disk partitions that can be configured is 7.
- Once the requested disk paritions are allocated, the remaining disk space is allocated to the node's boot disk.
- A Node Pool's custom disk layout is immutable over the lifetime of the Node Pool.
An array of tags applied to this object. Tags are for organizational purposes only.
Request Samples
- Shell
- CLI
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"type": "g6-standard-4",
"count": 6,
"tags": ["example-tag"],
"autoscaler": {
"enabled": true,
"max": 12,
"min": 3
}
}' \
https://api.linode.com/v4/lke/clusters/12345/pools
Response Samples
- 200
- default
{
"id": 1234,
"type": "g6-standard-4",
"tags": [],
"disks": [
{
"size": 1024,
"type": "ext-4"
}
],
"autoscaler": {
"enabled": true,
"max": 12,
"min": 3
},
"count": 6,
"nodes": [
{
"id": "123456",
"instance_id": 123458,
"status": "ready"
}
]
}Responses
200: Node Pool has been created.
This Node Pool's unique ID.
The Linode Type for all of the nodes in the Node Pool.
An array of tags applied to this object. Tags are for organizational purposes only.
This Node Pool's custom disk layout.
The size of this custom disk partition in MB.
- The size of this disk partition must not exceed the capacity of the node's plan type.
This custom disk partition's filesystem type.
When enabled, the number of nodes autoscales within the defined minimum and maximum values.
Whether autoscaling is enabled for this Node Pool. Defaults to false.
The maximum number of nodes to autoscale to. Defaults to the Node Pool's count.
The minimum number of nodes to autoscale to. Defaults to the Node Pool's count.
The number of nodes in the Node Pool.
Status information for the Nodes which are members of this Node Pool. If a Linode has not been provisioned for a given Node slot, the instance_id will be returned as null.
The Node's ID.
The Linode's ID. When no Linode is currently provisioned for this Node, this will be null.
The Node's status as it pertains to being a Kubernetes node.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.