nodes

Creates, updates, deletes, gets or lists a nodes resource.

Overview

Name	nodes
Type	Resource
Id	ovh.cloud_kube.nodes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Node ID
name	string	Node name
instance_id	string	Public Cloud instance id (wire: instanceId)
node_pool_id	string	NodePool parent id (wire: nodePoolId)
project_id	string	Project id (wire: projectId)
created_at	string (date-time)	Creation date (wire: createdAt)
deleted_at	string (date-time)	Node deletion date (wire: deletedAt)
deployed_at	string (date-time)	Node deployment date (wire: deployedAt)
flavor	string	Flavor name
is_up_to_date	boolean	True if the node is up to date (wire: isUpToDate)
status	string	Status (DELETED, DELETING, ERROR, FLAVOR_OUT_OF_STOCK_ERROR, INSTALLING, MAINTENANCE, READY, REDEPLOYING, REOPENING, RESETTING, SUSPENDED, SUSPENDING, UNKNOWN, UPDATING, USER_ERROR, USER_NODE_NOT_FOUND_ERROR, USER_NODE_SUSPENDED_SERVICE, USER_QUOTA_ERROR, USER_WEBHOOK_PREVENTING_OPERATIONS_ERROR)
updated_at	string (date-time)	Node last update date (wire: updatedAt)
version	string	Node version

list

Node installed on your cluster

Name	Datatype	Description
id	string	Node ID
name	string	Node name
instance_id	string	Public Cloud instance id (wire: instanceId)
node_pool_id	string	NodePool parent id (wire: nodePoolId)
project_id	string	Project id (wire: projectId)
created_at	string (date-time)	Creation date (wire: createdAt)
deleted_at	string (date-time)	Node deletion date (wire: deletedAt)
deployed_at	string (date-time)	Node deployment date (wire: deployedAt)
flavor	string	Flavor name
is_up_to_date	boolean	True if the node is up to date (wire: isUpToDate)
status	string	Status (DELETED, DELETING, ERROR, FLAVOR_OUT_OF_STOCK_ERROR, INSTALLING, MAINTENANCE, READY, REDEPLOYING, REOPENING, RESETTING, SUSPENDED, SUSPENDING, UNKNOWN, UPDATING, USER_ERROR, USER_NODE_NOT_FOUND_ERROR, USER_NODE_SUSPENDED_SERVICE, USER_QUOTA_ERROR, USER_WEBHOOK_PREVENTING_OPERATIONS_ERROR)
updated_at	string (date-time)	Node last update date (wire: updatedAt)
version	string	Node version

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	kube_id, node_id, service_name		Get information on a specific node on your cluster
list	select	kube_id, service_name	x_pagination_cursor, history	List your nodes
delete	delete	kube_id, node_id, service_name		Delete a specific node on your cluster. This will also decrease by one the desirednodes value of its nodepool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
kube_id	string	Kube ID (wire: kubeId)
node_id	string	Node ID (wire: nodeId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
history	boolean	If set to true then returns DELETED nodes ordered by deletion date (most recently deleted first). Returns non-DELETED nodes if false or not set.
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)

SELECT examples

get

Get information on a specific node on your cluster

SELECT
id,
name,
instance_id,
node_pool_id,
project_id,
created_at,
deleted_at,
deployed_at,
flavor,
is_up_to_date,
status,
updated_at,
version
FROM ovh.cloud_kube.nodes
WHERE kube_id = '{{ kube_id }}' -- required
AND node_id = '{{ node_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List your nodes

SELECT
id,
name,
instance_id,
node_pool_id,
project_id,
created_at,
deleted_at,
deployed_at,
flavor,
is_up_to_date,
status,
updated_at,
version
FROM ovh.cloud_kube.nodes
WHERE kube_id = '{{ kube_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND history = '{{ history }}'
;

DELETE examples

delete

Delete a specific node on your cluster. This will also decrease by one the desirednodes value of its nodepool.

DELETE FROM ovh.cloud_kube.nodes
WHERE kube_id = '{{ kube_id }}' --required
AND node_id = '{{ node_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;