region_volume_backups

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

Overview

Name	region_volume_backups
Type	Resource
Id	ovh.cloud_storage.region_volume_backups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Volume backup id
name	string	Volume backup name
volume_id	string (uuid)	ID of the volume used to create the backup (wire: volumeId)
creation_date	string (date-time)	Creation date of the backup (wire: creationDate)
region	string	Volume backup region
size	integer	Size of the backup in GiB
status	string	Staus of the backup (creating, deleting, error, ok, restoring)

list

A volume backup

Name	Datatype	Description
id	string (uuid)	Volume backup id
name	string	Volume backup name
volume_id	string (uuid)	ID of the volume used to create the backup (wire: volumeId)
creation_date	string (date-time)	Creation date of the backup (wire: creationDate)
region	string	Volume backup region
size	integer	Size of the backup in GiB
status	string	Staus of the backup (creating, deleting, error, ok, restoring)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	region_name, volume_backup_id, service_name		Get volume backup
list	select	region_name, service_name		List volume backups
create	insert	region_name, service_name, volume_id		Create a volume backup
delete	delete	region_name, volume_backup_id, service_name		Delete volume backup
restore	exec	regionName, volumeBackupId, service_name, volumeId		Restore a volume backup on a volume
volume	exec	regionName, volumeBackupId, service_name		Create a volume from a volume 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"}})
regionName	string	Region name
region_name	string	Region name (wire: regionName)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
volumeBackupId	string (uuid)	Volume backup ID
volume_backup_id	string (uuid)	Volume backup ID (wire: volumeBackupId)

SELECT examples

get

Get volume backup

SELECT
id,
name,
volume_id,
creation_date,
region,
size,
status
FROM ovh.cloud_storage.region_volume_backups
WHERE region_name = '{{ region_name }}' -- required
AND volume_backup_id = '{{ volume_backup_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List volume backups

SELECT
id,
name,
volume_id,
creation_date,
region,
size,
status
FROM ovh.cloud_storage.region_volume_backups
WHERE region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Create a volume backup

INSERT INTO ovh.cloud_storage.region_volume_backups (
name,
volume_id,
region_name,
service_name
)
SELECT 
'{{ name }}',
'{{ volume_id }}' /* required */,
'{{ region_name }}',
'{{ service_name }}'
RETURNING
id,
name,
volume_id,
creation_date,
region,
size,
status
;

Manifest

# Description fields are for documentation purposes
- name: region_volume_backups
props:
  - name: region_name
    value: "{{ region_name }}"
    description: Required parameter for the region_volume_backups resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the region_volume_backups resource.
  - name: name
    value: "{{ name }}"
    description: |
      name of the backup
  - name: volume_id
    value: "{{ volume_id }}"
    description: |
      ID of the volume to backup

DELETE examples

delete

Delete volume backup

DELETE FROM ovh.cloud_storage.region_volume_backups
WHERE region_name = '{{ region_name }}' --required
AND volume_backup_id = '{{ volume_backup_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;

Lifecycle Methods

EXEC variables use wire (API) names.

restore

Restore a volume backup on a volume

EXEC ovh.cloud_storage.region_volume_backups.restore 
@regionName='{{ regionName }}' --required, 
@volumeBackupId='{{ volumeBackupId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set 
@@json=
'{
"volumeId": "{{ volumeId }}"
}'
;

volume

Create a volume from a volume backup

EXEC ovh.cloud_storage.region_volume_backups.volume 
@regionName='{{ regionName }}' --required, 
@volumeBackupId='{{ volumeBackupId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set 
@@json=
'{
"name": "{{ name }}"
}'
;