planned_interventions

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

Overview

Name	planned_interventions
Type	Resource
Id	ovh.dedicated_server.planned_interventions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	ID of the intervention
expected_end_date	string (date-time)	Expected end date for this intervention (wire: expectedEndDate)
status	string	Status of the intervention (doing, done, todo)
type	string	Operation purpose (HARDWARE_UPGRADE_ON_ACTIVE_SERVER)
wanted_start_date	string (date-time)	Wanted start date for this intervention (wire: wantedStartDate)

list

Planned intervention on the server

Name	Datatype	Description
id	integer	ID of the intervention
expected_end_date	string (date-time)	Expected end date for this intervention (wire: expectedEndDate)
status	string	Status of the intervention (doing, done, todo)
type	string	Operation purpose (HARDWARE_UPGRADE_ON_ACTIVE_SERVER)
wanted_start_date	string (date-time)	Wanted start date for this intervention (wire: wantedStartDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	intervention_id, service_name		Get a planned intervention. Returns the type, status, wanted start date and expected end date of an intervention planned on the server. The status is todo, doing or done. (Beta version)
list	select	service_name	x_pagination_mode	List planned interventions. Returns the IDs of the interventions planned on the server. Get a planned intervention to read its type, status and dates. (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"}})
intervention_id	integer	ID of the intervention (wire: interventionId)
service_name	string	The internal name of your dedicated server (wire: serviceName)
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

Get a planned intervention. Returns the type, status, wanted start date and expected end date of an intervention planned on the server. The status is todo, doing or done. (Beta version)

SELECT
id,
expected_end_date,
status,
type,
wanted_start_date
FROM ovh.dedicated_server.planned_interventions
WHERE intervention_id = '{{ intervention_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List planned interventions. Returns the IDs of the interventions planned on the server. Get a planned intervention to read its type, status and dates. (Beta version)

SELECT
id,
expected_end_date,
status,
type,
wanted_start_date
FROM ovh.dedicated_server.planned_interventions
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;