v1.Node
Description
Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).
Object Schema
Expand or mouse-over a field for more information about it.
apiVersion:kind:metadata:
annotations:
[string]:clusterName:creationTimestamp:deletionGracePeriodSeconds:deletionTimestamp:finalizers:
- [string]:generateName:generation:initializers:
pending:
- name:result:
apiVersion:code:details:
causes:
- field:message:reason:group:kind:name:retryAfterSeconds:uid:kind:message:metadata:
continue:resourceVersion:selfLink:reason:status:labels:
[string]:name:namespace:ownerReferences:
- apiVersion:blockOwnerDeletion:controller:kind:name:uid:resourceVersion:selfLink:uid:spec:
configSource:
apiVersion:configMapRef:
apiVersion:fieldPath:kind:name:namespace:resourceVersion:uid:kind:externalID:podCIDR:providerID:taints:
- effect:key:timeAdded:value:unschedulable:status:
addresses:
- address:type:allocatable:
[string]:capacity:
[string]:conditions:
- lastHeartbeatTime:lastTransitionTime:message:reason:status:type:daemonEndpoints:
kubeletEndpoint:
Port:images:
- names:
- - [string]:sizeBytes:nodeInfo:
architecture:bootID:containerRuntimeVersion:kernelVersion:kubeProxyVersion:kubeletVersion:machineID:operatingSystem:osImage:systemUUID:phase:volumesAttached:
- devicePath:name:volumesInUse:
- [string]:
Operations
Create a Node
Create a Node
HTTP request
POST /api/v1/nodes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "Node",
"apiVersion": "v1",
...
}
Get a Node
Read the specified Node
HTTP request
GET /api/v1/nodes/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME
Get all Nodes
List or watch objects of kind Node
HTTP request
GET /api/v1/nodes HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes
Query parameters
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch a Node
Watch changes to an object of kind Node
HTTP request
GET /api/v1/watch/nodes/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/watch/nodes/$NAME
Query parameters
| Parameter | Description |
|---|---|
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty |
If 'true', then the output is pretty printed. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch all Nodes
Watch individual changes to a list of Node
HTTP request
GET /api/v1/watch/nodes HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/watch/nodes
Query parameters
| Parameter | Description |
|---|---|
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty |
If 'true', then the output is pretty printed. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Update a Node
Replace the specified Node
HTTP request
PUT /api/v1/nodes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "Node",
"apiVersion": "v1",
...
}
Patch a Node
Partially update the specified Node
HTTP request
PATCH /api/v1/nodes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
...
}
Curl request
$ curl -k \
-X PATCH \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json-patch+json' \
https://$ENDPOINT/api/v1/nodes/$NAME <<'EOF'
{
...
}
EOF
Delete a Node
Delete a Node
HTTP request
DELETE /api/v1/nodes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
...
}
Curl request
$ curl -k \
-X DELETE \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME <<'EOF'
{
...
}
EOF
Query parameters
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
Delete all Nodes
Delete collection of Node
HTTP request
DELETE /api/v1/nodes HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X DELETE \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes
Query parameters
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Get status of a Node
Read status of the specified Node
HTTP request
GET /api/v1/nodes/$NAME/status HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Update status of a Node
Replace status of the specified Node
HTTP request
PUT /api/v1/nodes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "Node",
"apiVersion": "v1",
...
}
Patch status of a Node
Partially update status of the specified Node
HTTP request
PATCH /api/v1/nodes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
...
}
Curl request
$ curl -k \
-X PATCH \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json-patch+json' \
https://$ENDPOINT/api/v1/nodes/$NAME/status <<'EOF'
{
...
}
EOF
Proxy OPTIONS request to a Node
Connect OPTIONS requests to proxy of Node
HTTP request
OPTIONS /api/v1/nodes/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X OPTIONS \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy
Proxy POST request to a Node
Connect POST requests to proxy of Node
HTTP request
POST /api/v1/nodes/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X POST \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy
Proxy HEAD request to a Node
Connect HEAD requests to proxy of Node
HTTP request
HEAD /api/v1/nodes/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X HEAD \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy
Proxy GET request to a Node
Connect GET requests to proxy of Node
HTTP request
GET /api/v1/nodes/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy
Proxy PUT request to a Node
Connect PUT requests to proxy of Node
HTTP request
PUT /api/v1/nodes/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X PUT \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy
Proxy PATCH request to a Node
Connect PATCH requests to proxy of Node
HTTP request
PATCH /api/v1/nodes/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X PATCH \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy
Proxy DELETE request to a Node
Connect DELETE requests to proxy of Node
HTTP request
DELETE /api/v1/nodes/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X DELETE \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy
Proxy OPTIONS request to a Node (with path)
Connect OPTIONS requests to proxy of Node
HTTP request
OPTIONS /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X OPTIONS \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH
Proxy POST request to a Node (with path)
Connect POST requests to proxy of Node
HTTP request
POST /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X POST \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH
Proxy HEAD request to a Node (with path)
Connect HEAD requests to proxy of Node
HTTP request
HEAD /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X HEAD \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH
Proxy GET request to a Node (with path)
Connect GET requests to proxy of Node
HTTP request
GET /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH
Proxy PUT request to a Node (with path)
Connect PUT requests to proxy of Node
HTTP request
PUT /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X PUT \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH
Proxy PATCH request to a Node (with path)
Connect PATCH requests to proxy of Node
HTTP request
PATCH /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X PATCH \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH
Proxy DELETE request to a Node (with path)
Connect DELETE requests to proxy of Node
HTTP request
DELETE /api/v1/nodes/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X DELETE \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/api/v1/nodes/$NAME/proxy/$PATH