- Node [v1]
- Specification
- .spec
- .spec.configSource
- .spec.configSource.configMap
- .spec.taints
- .spec.taints[]
- .status
- .status.addresses
- .status.addresses[]
- .status.conditions
- .status.conditions[]
- .status.config
- .status.config.active
- .status.config.active.configMap
- .status.config.assigned
- .status.config.assigned.configMap
- .status.config.lastKnownGood
- .status.config.lastKnownGood.configMap
- .status.daemonEndpoints
- .status.daemonEndpoints.kubeletEndpoint
- .status.images
- .status.images[]
- .status.nodeInfo
- .status.volumesAttached
- .status.volumesAttached[]
- API endpoints
- Specification
Node [v1]
Description
Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).
Type
object
Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| NodeSpec describes the attributes that a node is created with. |
|
| 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 |
---|---|---|
|
| NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 |
|
| Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 |
|
| PodCIDR represents the pod IP range assigned to the node. |
|
| 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. |
|
| ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID> |
|
| If specified, the node’s taints. |
|
| The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint. |
|
| 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 |
---|---|---|
|
| 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 declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. |
|
| Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. |
|
| Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. |
|
| ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
|
| 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 |
---|---|---|
|
| Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. |
|
| Required. The taint key to be applied to a node. |
| TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. | |
|
| 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 |
---|---|---|
|
| 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. |
|
| NodeAddress contains information for the node’s address. |
| Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. | |
| Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | |
|
| Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition |
|
| NodeCondition contains condition information for a node. |
|
| NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource. |
|
| NodeDaemonEndpoints lists ports opened by daemons running on the Node. |
|
| List of container images on this node |
|
| Describe a container image |
|
| NodeSystemInfo is a set of ids/uuids to uniquely identify the node. |
|
| 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. |
|
| List of volumes that are attached to the node. |
|
| AttachedVolume describes a volume attached to a node |
|
| 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 |
---|---|---|
|
| The node address. |
|
| 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 |
---|---|---|
| Last time we got an update on a given condition. | |
| Last time the condition transit from one status to another. | |
|
| Human readable message indicating details about last transition. |
|
| (brief) reason for the condition’s last transition. |
|
| Status of the condition, one of True, False, Unknown. |
|
| Type of node condition. |
.status.config
Description
NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.
Type
object
Property | Type | Description |
---|---|---|
|
| NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 |
|
| NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 |
|
| 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. |
|
| 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 |
---|---|---|
|
| 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 declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. |
|
| Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. |
|
| Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. |
|
| ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
|
| 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 |
---|---|---|
|
| 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 declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. |
|
| Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. |
|
| Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. |
|
| ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
|
| 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 |
---|---|---|
|
| 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 declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. |
|
| Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. |
|
| Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. |
|
| ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
|
| 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 |
---|---|---|
|
| 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 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 by which this image is known. e.g. [“k8s.gcr.io/hyperkube:v1.0.7”, “dockerhub.io/google_containers/hyperkube:v1.0.7”] |
|
| 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 |
---|---|---|
|
| The Architecture reported by the node |
|
| Boot ID reported by the node. |
|
| ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0). |
|
| Kernel Version reported by the node from ‘uname -r’ (e.g. 3.16.0-0.bpo.4-amd64). |
|
| KubeProxy Version reported by the node. |
|
| Kubelet Version reported by the node. |
|
| 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 |
|
| The Operating System reported by the node |
|
| OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). |
|
| 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 represents the device path where the volume should be available |
|
| Name of the attached volume |
API endpoints
The following API endpoints are available:
/api/v1/nodes
DELETE
: delete collection of NodeGET
: list or watch objects of kind NodePOST
: 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 NodeGET
: read the specified NodePATCH
: partially update the specified NodePUT
: 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 NodePATCH
: partially update status of the specified NodePUT
: replace status of the specified Node
/api/v1/nodes
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete collection of Node
Parameter | Type | Description |
---|---|---|
|
| 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. |
|
| 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 |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| 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. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| 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. |
|
| 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. |
|
| 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 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 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 |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
Parameter | Type | Description |
---|---|---|
| DeleteOptions schema |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list or watch objects of kind Node
Parameter | Type | Description |
---|---|---|
|
| 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. |
|
| 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. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| 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 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 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 |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK | NodeList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a Node
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
| Node schema |
HTTP code | Reponse body |
---|---|
200 - OK | Node schema |
201 - Created | Node schema |
202 - Accepted | Node schema |
401 - Unauthorized | Empty |
/api/v1/watch/nodes
Parameter | Type | Description |
---|---|---|
|
| 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. |
|
| 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. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| 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. |
|
| If ‘true’, then the output is pretty printed. |
|
| 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 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 |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP method
GET
Description
watch individual changes to a list of Node. deprecated: use the ‘watch’ parameter with a list operation instead.
HTTP code | Reponse body |
---|---|
200 - OK | WatchEvent schema |
401 - Unauthorized | Empty |
/api/v1/nodes/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the Node |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete a Node
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| 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. |
|
| 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. |
|
| 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. |
Parameter | Type | Description |
---|---|---|
| DeleteOptions schema |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified Node
HTTP code | Reponse body |
---|---|
200 - OK | Node schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified Node
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
|
| Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
Parameter | Type | Description |
---|---|---|
| Patch schema |
HTTP code | Reponse body |
---|---|
200 - OK | Node schema |
201 - Created | Node schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified Node
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
| Node schema |
HTTP code | Reponse body |
---|---|
200 - OK | Node schema |
201 - Created | Node schema |
401 - Unauthorized | Empty |
/api/v1/watch/nodes/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the Node |
Parameter | Type | Description |
---|---|---|
|
| 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. |
|
| 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. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| 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. |
|
| If ‘true’, then the output is pretty printed. |
|
| 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 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 |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP method
GET
Description
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.
HTTP code | Reponse body |
---|---|
200 - OK | WatchEvent schema |
401 - Unauthorized | Empty |
/api/v1/nodes/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the Node |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
GET
Description
read status of the specified Node
HTTP code | Reponse body |
---|---|
200 - OK | Node schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified Node
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
|
| Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
Parameter | Type | Description |
---|---|---|
| Patch schema |
HTTP code | Reponse body |
---|---|
200 - OK | Node schema |
201 - Created | Node schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified Node
Parameter | Type | Description |
---|---|---|
|
| 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 |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
| Node schema |
HTTP code | Reponse body |
---|---|
200 - OK | Node schema |
201 - Created | Node schema |
401 - Unauthorized | Empty |