notebook_backups

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

Overview

Name	notebook_backups
Type	Resource
Id	ovh.cloud_ai.notebook_backups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Backup Id
created_at	string (date-time)	Backup creation date (wire: createdAt)
eviction_date	string (date-time)	date at which the notebook backup will be evicted/deleted according to applicable notebook workspace backup retention policy (wire: evictionDate)
updated_at	string (date-time)	Backup last update date (wire: updatedAt)

list

AI Solutions Platform Notebook Backup Object

Name	Datatype	Description
id	string	Backup Id
created_at	string (date-time)	Backup creation date (wire: createdAt)
eviction_date	string (date-time)	date at which the notebook backup will be evicted/deleted according to applicable notebook workspace backup retention policy (wire: evictionDate)
updated_at	string (date-time)	Backup last update date (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	backup_id, notebook_id, service_name		Get details for a single AI Solutions notebook backup
list	select	notebook_id, service_name	order, page, size, sort, updated_after, updated_before	List all backups of an AI Solutions notebook
fork	exec	backupId, notebookId, service_name		Starts a new AI Solutions notebook from a backup

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"}})
backupId	string	Backup ID
backup_id	string	Backup ID (wire: backupId)
notebookId	string	Notebook ID
notebook_id	string	Notebook ID (wire: notebookId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
order	string	Order the result set
page	integer	Page of the result set
size	integer	Size of the result set
sort	string	Sort the result with this field
updated_after	string (date-time)	Filter on updatedAt property (>) (wire: updatedAfter)
updated_before	string (date-time)	Filter on updatedAt property (<) (wire: updatedBefore)

SELECT examples

get

Get details for a single AI Solutions notebook backup

SELECT
id,
created_at,
eviction_date,
updated_at
FROM ovh.cloud_ai.notebook_backups
WHERE backup_id = '{{ backup_id }}' -- required
AND notebook_id = '{{ notebook_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List all backups of an AI Solutions notebook

SELECT
id,
created_at,
eviction_date,
updated_at
FROM ovh.cloud_ai.notebook_backups
WHERE notebook_id = '{{ notebook_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND order = '{{ order }}'
AND page = '{{ page }}'
AND size = '{{ size }}'
AND sort = '{{ sort }}'
AND updated_after = '{{ updated_after }}'
AND updated_before = '{{ updated_before }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

fork

Starts a new AI Solutions notebook from a backup

EXEC ovh.cloud_ai.notebook_backups.fork 
@backupId='{{ backupId }}' --required, 
@notebookId='{{ notebookId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set 
@@json=
'{
"name": "{{ name }}"
}'
;