managed_kubernetes_nodepool_nodes

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

Overview

Name	managed_kubernetes_nodepool_nodes
Type	Resource
Id	ovh.public_cloud_kubernetes.managed_kubernetes_nodepool_nodes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the node
created_at	string (date-time)	Node creation timestamp (wire: createdAt)
current_state	object	Actual node state (wire: currentState)
resource_status	string	Current lifecycle status of the node (CREATING, DELETED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
updated_at	string (date-time)	Last node modification timestamp (wire: updatedAt)

list

A node of a managed Kubernetes cluster nodepool

Name	Datatype	Description
id	string (uuid)	Unique identifier of the node
created_at	string (date-time)	Node creation timestamp (wire: createdAt)
current_state	object	Actual node state (wire: currentState)
resource_status	string	Current lifecycle status of the node (CREATING, DELETED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
updated_at	string (date-time)	Last node modification timestamp (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	managed_kubernetes_id, node_id, node_pool_id, project_id		A deleted node kept in retention is returned with resourceStatus DELETED until it expires, after which the call returns 404. (Beta version)
list	select	managed_kubernetes_id, node_pool_id, project_id	x_pagination_cursor, x_pagination_size, include_deleted, resource_status	Deleted nodes kept in retention are excluded unless includeDeleted is true. (Beta version)

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"}})
managed_kubernetes_id	string (uuid)	Managed kubernetes ID (wire: managedKubernetesId)
node_id	string (uuid)	Node ID (wire: nodeId)
node_pool_id	string (uuid)	Node pool ID (wire: nodePoolId)
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
include_deleted	boolean	Include deleted nodes still kept in retention (wire: includeDeleted)
resource_status	string	Return only the nodes in this lifecycle status. Filtering on DELETED requires includeDeleted set to true, otherwise the request returns 400. (wire: resourceStatus)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

A deleted node kept in retention is returned with resourceStatus DELETED until it expires, after which the call returns 404. (Beta version)

SELECT
id,
created_at,
current_state,
resource_status,
updated_at
FROM ovh.public_cloud_kubernetes.managed_kubernetes_nodepool_nodes
WHERE managed_kubernetes_id = '{{ managed_kubernetes_id }}' -- required
AND node_id = '{{ node_id }}' -- required
AND node_pool_id = '{{ node_pool_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Deleted nodes kept in retention are excluded unless includeDeleted is true. (Beta version)

SELECT
id,
created_at,
current_state,
resource_status,
updated_at
FROM ovh.public_cloud_kubernetes.managed_kubernetes_nodepool_nodes
WHERE managed_kubernetes_id = '{{ managed_kubernetes_id }}' -- required
AND node_pool_id = '{{ node_pool_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND include_deleted = '{{ include_deleted }}'
AND resource_status = '{{ resource_status }}'
;