clusters

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

Overview

Name	clusters
Type	Resource
Id	ovh.dedicated_cluster.clusters

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Cluster's ID
iam	object	IAM resource metadata
model	string	Model of the cluster
nodes	array	Cluster's nodes
region	string	Region where cluster is located
status	string	Cluster status

list

A structure describing the dedicated cluster

Name	Datatype	Description
id	string (uuid)	Cluster's ID
iam	object	IAM resource metadata
model	string	Model of the cluster
nodes	array	Cluster's nodes
region	string	Region where cluster is located
status	string	Cluster status

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns the ID, model, region and status of a dedicated cluster, and its nodes. (Beta version)
list	select		iam_tags, x_pagination_mode	Returns the IDs of the dedicated clusters of the account. (Beta version)
change_contact	exec	serviceName		Starts a contact change procedure for the admin, billing or tech contact of the cluster. Returns the IDs of the contact change tasks. (Beta version)
confirm_termination	exec	serviceName, token		Confirms the termination of the cluster with the token sent by email to the admin contact. (Beta version)
terminate	exec	serviceName		Starts the termination of the cluster and sends a confirmation token by email to the admin contact. Confirm it with the termination confirmation. (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"}})
serviceName	string (uuid)	Service name
service_name	string (uuid)	Service name (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Returns the ID, model, region and status of a dedicated cluster, and its nodes. (Beta version)

SELECT
id,
iam,
model,
nodes,
region,
status
FROM ovh.dedicated_cluster.clusters
WHERE service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the dedicated clusters of the account. (Beta version)

SELECT
id,
iam,
model,
nodes,
region,
status
FROM ovh.dedicated_cluster.clusters
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_contact

Starts a contact change procedure for the admin, billing or tech contact of the cluster. Returns the IDs of the contact change tasks. (Beta version)

EXEC ovh.dedicated_cluster.clusters.change_contact 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactTech": "{{ contactTech }}"
}'
;

confirm_termination

Confirms the termination of the cluster with the token sent by email to the admin contact. (Beta version)

EXEC ovh.dedicated_cluster.clusters.confirm_termination 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"commentary": "{{ commentary }}", 
"commentaryFutureUse": "{{ commentaryFutureUse }}", 
"commentaryReason": "{{ commentaryReason }}", 
"futureUse": "{{ futureUse }}", 
"reason": "{{ reason }}", 
"token": "{{ token }}"
}'
;

terminate

Starts the termination of the cluster and sends a confirmation token by email to the admin contact. Confirm it with the termination confirmation. (Beta version)

EXEC ovh.dedicated_cluster.clusters.terminate 
@serviceName='{{ serviceName }}' --required
;