backups

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

Overview

Name	backups
Type	Resource
Id	ovh.public_cloud_analytics.backups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the backup
service_id	string (uuid)	Identifier of the service this backup belongs to (wire: serviceId)
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the backup was created (wire: createdAt)
description	string	Human-readable description of the backup
expired_at	string (date-time)	Date until point-in-time recovery is available from this backup (wire: expiredAt)
regions	array	Regions where this backup is stored
size	object	Size of the backup
status	string	Current readiness status of the backup (CREATING, DELETING, ERROR, READY)
type	string	Type of this backup (AUTOMATIC, MANUAL, NONE, PITR, SNAPSHOT)

list

A backup of a managed database service

Name	Datatype	Description
id	string (uuid)	Unique identifier of the backup
service_id	string (uuid)	Identifier of the service this backup belongs to (wire: serviceId)
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the backup was created (wire: createdAt)
description	string	Human-readable description of the backup
expired_at	string (date-time)	Date until point-in-time recovery is available from this backup (wire: expiredAt)
regions	array	Regions where this backup is stored
size	object	Size of the backup
status	string	Current readiness status of the backup (CREATING, DELETING, ERROR, READY)
type	string	Type of this backup (AUTOMATIC, MANUAL, NONE, PITR, SNAPSHOT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	backup_id, project_id		Returns the backup type, size, status and storage regions, and the date until which point-in-time recovery is available. (Beta version)
list	select	project_id	x_pagination_cursor, x_pagination_size, service_id	Returns the backups of all analytics services of the project, across engines. Filter them by service with the serviceId parameter. (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"}})
backup_id	string (uuid)	Backup ID (wire: backupId)
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
service_id	string (uuid)	Filter backups by service identifier (wire: serviceId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the backup type, size, status and storage regions, and the date until which point-in-time recovery is available. (Beta version)

SELECT
id,
service_id,
checksum,
created_at,
description,
expired_at,
regions,
size,
status,
type
FROM ovh.public_cloud_analytics.backups
WHERE backup_id = '{{ backup_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the backups of all analytics services of the project, across engines. Filter them by service with the serviceId parameter. (Beta version)

SELECT
id,
service_id,
checksum,
created_at,
description,
expired_at,
regions,
size,
status,
type
FROM ovh.public_cloud_analytics.backups
WHERE 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 service_id = '{{ service_id }}'
;