kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
website/docs/api-reference/v1.5/documents/_generated_node_v1_concept.md

27 KiB
Raw Blame History

Node v1

Group Version Kind
Core v1 Node

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		 Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec
NodeSpec		 Spec defines the behavior of a node. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status
NodeStatus		 Most recently observed status of the node. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

NodeSpec v1

Field Description
externalID
string		 External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated.
podCIDR
string		 PodCIDR represents the pod IP range assigned to the node.
providerID
string		 ID of the node assigned by the cloud provider in the format: ://
unschedulable
boolean		 Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration"

NodeStatus v1

Field Description
addresses
NodeAddress array		 List of addresses reachable to the node. Queried from cloud provider, if available. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses
allocatable
object		 Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
capacity
object		 Capacity represents the total resources of a node. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#capacity for more details.
conditions
NodeCondition array		 Conditions is an array of current observed node conditions. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition
daemonEndpoints
NodeDaemonEndpoints		 Endpoints of daemons running on the Node.
images
ContainerImage array		 List of container images on this node
nodeInfo
NodeSystemInfo		 Set of ids/uuids to uniquely identify the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-info
phase
string		 NodePhase is the recently observed lifecycle phase of the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase The field is never populated, and now is deprecated.
volumesAttached
AttachedVolume array		 List of volumes that are attached to the node.
volumesInUse
string array		 List of attachable volumes in use (mounted) by the node.

NodeList v1

Field 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items
Node array		 List of nodes
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ListMeta		 Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

create a Node

HTTP Request

POST /api/v1/nodes

Query Parameters

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

Body Parameters

Parameter Description
body
Node

Response

Code Description
200
Node		 OK

Replace

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

replace the specified Node

HTTP Request

PUT /api/v1/nodes/{name}

Path Parameters

Parameter Description
name name of the Node

Query Parameters

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

Body Parameters

Parameter Description
body
Node

Response

Code Description
200
Node		 OK

Patch

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

partially update the specified Node

HTTP Request

PATCH /api/v1/nodes/{name}

Path Parameters

Parameter Description
name name of the Node

Query Parameters

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

Body Parameters

Parameter Description
body
Patch

Response

Code Description
200
Node		 OK

Delete

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

delete a Node

HTTP Request

DELETE /api/v1/nodes/{name}

Path Parameters

Parameter Description
name name of the Node

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 Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.

Body Parameters

Parameter Description
body
DeleteOptions

Response

Code Description
200
Status		 OK

Delete Collection

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

delete collection of Node

HTTP Request

DELETE /api/v1/nodes

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
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.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Status		 OK

Read Operations

See supported operations below...

Read

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

read the specified Node

HTTP Request

GET /api/v1/nodes/{name}

Path Parameters

Parameter Description
name name of the Node

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
export Should this value be exported. Export strips fields that a user can not specify.

Response

Code Description
200
Node		 OK

List

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

list or watch objects of kind Node

HTTP Request

GET /api/v1/nodes

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
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.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
NodeList		 OK

Watch

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

watch changes to an object of kind Node

HTTP Request

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

Path Parameters

Parameter Description
name name of the Node

Query Parameters

Parameter Description
fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
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.
timeoutSeconds Timeout for the list/watch call.
watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code Description
200
Event		 OK

Proxy Operations

See supported operations below...

Create Connect Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect POST requests to proxy of Node

HTTP Request

POST /api/v1/nodes/{name}/proxy

Path Parameters

Parameter Description
name name of the Node

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to node.

Response

Code Description
200
string		 OK

Create Connect Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect POST requests to proxy of Node

HTTP Request

POST /api/v1/nodes/{name}/proxy/{path}

Path Parameters

Parameter Description
name name of the Node
path path to the resource

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to node.

Response

Code Description
200
string		 OK

Create Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy POST requests to Node

HTTP Request

POST /api/v1/proxy/nodes/{name}

Path Parameters

Parameter Description
name name of the Node

Response

Code Description
200
string		 OK

Create Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy POST requests to Node

HTTP Request

POST /api/v1/proxy/nodes/{name}/{path}

Path Parameters

Parameter Description
name name of the Node
path path to the resource

Response

Code Description
200
string		 OK

Delete Connect Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect DELETE requests to proxy of Node

HTTP Request

DELETE /api/v1/nodes/{name}/proxy

Path Parameters

Parameter Description
name name of the Node

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to node.

Response

Code Description
200
string		 OK

Delete Connect Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect DELETE requests to proxy of Node

HTTP Request

DELETE /api/v1/nodes/{name}/proxy/{path}

Path Parameters

Parameter Description
name name of the Node
path path to the resource

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to node.

Response

Code Description
200
string		 OK

Delete Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy DELETE requests to Node

HTTP Request

DELETE /api/v1/proxy/nodes/{name}

Path Parameters

Parameter Description
name name of the Node

Response

Code Description
200
string		 OK

Delete Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy DELETE requests to Node

HTTP Request

DELETE /api/v1/proxy/nodes/{name}/{path}

Path Parameters

Parameter Description
name name of the Node
path path to the resource

Response

Code Description
200
string		 OK

Get Connect Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect GET requests to proxy of Node

HTTP Request

GET /api/v1/nodes/{name}/proxy

Path Parameters

Parameter Description
name name of the Node

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to node.

Response

Code Description
200
string		 OK

Get Connect Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect GET requests to proxy of Node

HTTP Request

GET /api/v1/nodes/{name}/proxy/{path}

Path Parameters

Parameter Description
name name of the Node
path path to the resource

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to node.

Response

Code Description
200
string		 OK

Get Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy GET requests to Node

HTTP Request

GET /api/v1/proxy/nodes/{name}

Path Parameters

Parameter Description
name name of the Node

Response

Code Description
200
string		 OK

Get Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy GET requests to Node

HTTP Request

GET /api/v1/proxy/nodes/{name}/{path}

Path Parameters

Parameter Description
name name of the Node
path path to the resource

Response

Code Description
200
string		 OK

Head Connect Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect HEAD requests to proxy of Node

HTTP Request

HEAD /api/v1/nodes/{name}/proxy

Path Parameters

Parameter Description
name name of the Node

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to node.

Response

Code Description
200
string		 OK

Head Connect Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect HEAD requests to proxy of Node

HTTP Request

HEAD /api/v1/nodes/{name}/proxy/{path}

Path Parameters

Parameter Description
name name of the Node
path path to the resource

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to node.

Response

Code Description
200
string		 OK

Replace Connect Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect PUT requests to proxy of Node

HTTP Request

PUT /api/v1/nodes/{name}/proxy

Path Parameters

Parameter Description
name name of the Node

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to node.

Response

Code Description
200
string		 OK

Replace Connect Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect PUT requests to proxy of Node

HTTP Request

PUT /api/v1/nodes/{name}/proxy/{path}

Path Parameters

Parameter Description
name name of the Node
path path to the resource

Query Parameters

Parameter Description
path Path is the URL path to use for the current proxy request to node.

Response

Code Description
200
string		 OK

Replace Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy PUT requests to Node

HTTP Request

PUT /api/v1/proxy/nodes/{name}

Path Parameters

Parameter Description
name name of the Node

Response

Code Description
200
string		 OK

Replace Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy PUT requests to Node

HTTP Request

PUT /api/v1/proxy/nodes/{name}/{path}

Path Parameters

Parameter Description
name name of the Node
path path to the resource

Response

Code Description
200
string		 OK