×

Specification

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

NodeSpec describes the attributes that a node is created with.

status

object

NodeStatus is information about the current status of a node.

.spec

Description

NodeSpec describes the attributes that a node is created with.

Type

object

Property Type Description

configSource

object

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

externalID

string

Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966

podCIDR

string

PodCIDR represents the pod IP range assigned to the node.

podCIDRs

array (string)

podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6.

providerID

string

ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>

taints

array

If specified, the node’s taints.

taints[]

object

The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.

unschedulable

boolean

Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration

.spec.configSource

Description

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

Type

object

Property Type Description

configMap

object

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

.spec.configSource.configMap

Description

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

Type

object

Required
  • namespace

  • name

  • kubeletConfigKey

Property Type Description

kubeletConfigKey

string

KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.

name

string

Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.

namespace

string

Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.

resourceVersion

string

ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

uid

string

UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

.spec.taints

Description

If specified, the node’s taints.

Type

array

.spec.taints[]

Description

The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.

Type

object

Required
  • key

  • effect

Property Type Description

effect

string

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

key

string

Required. The taint key to be applied to a node.

timeAdded

Time

TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.

value

string

The taint value corresponding to the taint key.

.status

Description

NodeStatus is information about the current status of a node.

Type

object

Property Type Description

addresses

array

List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See http://pr.k8s.io/79391 for an example.

addresses[]

object

NodeAddress contains information for the node’s address.

allocatable

object (Quantity)

Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.

capacity

object (Quantity)

Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

conditions

array

Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition

conditions[]

object

NodeCondition contains condition information for a node.

config

object

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

daemonEndpoints

object

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

images

array

List of container images on this node

images[]

object

Describe a container image

nodeInfo

object

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

phase

string

NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.

volumesAttached

array

List of volumes that are attached to the node.

volumesAttached[]

object

AttachedVolume describes a volume attached to a node

volumesInUse

array (string)

List of attachable volumes in use (mounted) by the node.

.status.addresses

Description

List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See http://pr.k8s.io/79391 for an example.

Type

array

.status.addresses[]

Description

NodeAddress contains information for the node’s address.

Type

object

Required
  • type

  • address

Property Type Description

address

string

The node address.

type

string

Node address type, one of Hostname, ExternalIP or InternalIP.

.status.conditions

Description

Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition

Type

array

.status.conditions[]

Description

NodeCondition contains condition information for a node.

Type

object

Required
  • type

  • status

Property Type Description

lastHeartbeatTime

Time

Last time we got an update on a given condition.

lastTransitionTime

Time

Last time the condition transit from one status to another.

message

string

Human readable message indicating details about last transition.

reason

string

(brief) reason for the condition’s last transition.

status

string

Status of the condition, one of True, False, Unknown.

type

string

Type of node condition.

.status.config

Description

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

Type

object

Property Type Description

active

object

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

assigned

object

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

error

string

Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions.

lastKnownGood

object

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

.status.config.active

Description

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

Type

object

Property Type Description

configMap

object

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

.status.config.active.configMap

Description

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

Type

object

Required
  • namespace

  • name

  • kubeletConfigKey

Property Type Description

kubeletConfigKey

string

KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.

name

string

Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.

namespace

string

Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.

resourceVersion

string

ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

uid

string

UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

.status.config.assigned

Description

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

Type

object

Property Type Description

configMap

object

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

.status.config.assigned.configMap

Description

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

Type

object

Required
  • namespace

  • name

  • kubeletConfigKey

Property Type Description

kubeletConfigKey

string

KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.

name

string

Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.

namespace

string

Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.

resourceVersion

string

ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

uid

string

UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

.status.config.lastKnownGood

Description

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

Type

object

Property Type Description

configMap

object

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

.status.config.lastKnownGood.configMap

Description

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

Type

object

Required
  • namespace

  • name

  • kubeletConfigKey

Property Type Description

kubeletConfigKey

string

KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.

name

string

Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.

namespace

string

Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.

resourceVersion

string

ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

uid

string

UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

.status.daemonEndpoints

Description

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

Type

object

Property Type Description

kubeletEndpoint

object

DaemonEndpoint contains information about a single Daemon endpoint.

.status.daemonEndpoints.kubeletEndpoint

Description

DaemonEndpoint contains information about a single Daemon endpoint.

Type

object

Required
  • Port

Property Type Description

Port

integer

Port number of the given endpoint.

.status.images

Description

List of container images on this node

Type

array

.status.images[]

Description

Describe a container image

Type

object

Property Type Description

names

array (string)

Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]

sizeBytes

integer

The size of the image in bytes.

.status.nodeInfo

Description

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

Type

object

Required
  • machineID

  • systemUUID

  • bootID

  • kernelVersion

  • osImage

  • containerRuntimeVersion

  • kubeletVersion

  • kubeProxyVersion

  • operatingSystem

  • architecture

Property Type Description

architecture

string

The Architecture reported by the node

bootID

string

Boot ID reported by the node.

containerRuntimeVersion

string

ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).

kernelVersion

string

Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).

kubeProxyVersion

string

KubeProxy Version reported by the node.

kubeletVersion

string

Kubelet Version reported by the node.

machineID

string

MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html

operatingSystem

string

The Operating System reported by the node

osImage

string

OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

systemUUID

string

SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid

.status.volumesAttached

Description

List of volumes that are attached to the node.

Type

array

.status.volumesAttached[]

Description

AttachedVolume describes a volume attached to a node

Type

object

Required
  • name

  • devicePath

Property Type Description

devicePath

string

DevicePath represents the device path where the volume should be available

name

string

Name of the attached volume

API endpoints

The following API endpoints are available:

  • /api/v1/nodes

    • DELETE: delete collection of Node

    • GET: list or watch objects of kind Node

    • POST: create a Node

  • /api/v1/watch/nodes

    • GET: watch individual changes to a list of Node. deprecated: use the 'watch' parameter with a list operation instead.

  • /api/v1/nodes/{name}

    • DELETE: delete a Node

    • GET: read the specified Node

    • PATCH: partially update the specified Node

    • PUT: replace the specified Node

  • /api/v1/watch/nodes/{name}

    • GET: watch changes to an object of kind Node. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

  • /api/v1/nodes/{name}/status

    • GET: read status of the specified Node

    • PATCH: partially update status of the specified Node

    • PUT: replace status of the specified Node

/api/v1/nodes

Table 1. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

DELETE

Description

delete collection of Node

Table 2. Query parameters
Parameter Type Description

continue

string

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

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.

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

gracePeriodSeconds

integer

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.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

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.

orphanDependents

boolean

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

string

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.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

Table 3. Body parameters
Parameter Type Description

body

DeleteOptions schema

Table 4. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list or watch objects of kind Node

Table 5. Query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue

string

Th