compute_snapshots

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

Overview

Name	compute_snapshots
Type	Resource
Id	ovh.public_cloud.compute_snapshots

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the snapshot
checksum	string	Computed hash representing the current target specification value
created_at	string (date-time)	Creation date of the snapshot (wire: createdAt)
current_state	object	Current state of the snapshot (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the snapshot (wire: currentTasks)
resource_status	string	Snapshot readiness in the system (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Last target specification of the snapshot (wire: targetSpec)
updated_at	string (date-time)	Last update date of the snapshot (wire: updatedAt)

list

A Public Cloud instance snapshot (Glance image created from an instance)

Name	Datatype	Description
id	string (uuid)	Unique identifier of the snapshot
checksum	string	Computed hash representing the current target specification value
created_at	string (date-time)	Creation date of the snapshot (wire: createdAt)
current_state	object	Current state of the snapshot (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the snapshot (wire: currentTasks)
resource_status	string	Snapshot readiness in the system (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Last target specification of the snapshot (wire: targetSpec)
updated_at	string (date-time)	Last update date of the snapshot (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	snapshot_id, project_id		Returns the snapshot image, including its status and the instance it was created from.
list	select	project_id	x_pagination_cursor, x_pagination_size, instance_id	Returns the snapshots of the project.
create	insert	project_id, target_spec		Creates a snapshot image of the instance's current disk. Its id can be used as image.id to create a new instance from it.
delete	delete	snapshot_id, project_id		Deletes the snapshot image.

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"}})
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
snapshot_id	string (uuid)	Snapshot ID (wire: snapshotId)
instance_id	string (uuid)	Filter by source instance ID (wire: instanceId)
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 snapshot image, including its status and the instance it was created from.

SELECT
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
FROM ovh.public_cloud.compute_snapshots
WHERE snapshot_id = '{{ snapshot_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the snapshots of the project.

SELECT
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
FROM ovh.public_cloud.compute_snapshots
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 instance_id = '{{ instance_id }}'
;

INSERT examples

create

Creates a snapshot image of the instance's current disk. Its id can be used as image.id to create a new instance from it.

INSERT INTO ovh.public_cloud.compute_snapshots (
target_spec,
project_id
)
SELECT 
'{{ target_spec }}' /* required */,
'{{ project_id }}'
RETURNING
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: compute_snapshots
props:
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the compute_snapshots resource.
  - name: target_spec
    description: |
      Desired target specification for the snapshot to create
    value:
      instance:
        id: "{{ id }}"
      location:
        availabilityZone: "{{ availabilityZone }}"
        region: "{{ region }}"
      name: "{{ name }}"

DELETE examples

delete

Deletes the snapshot image.

DELETE FROM ovh.public_cloud.compute_snapshots
WHERE snapshot_id = '{{ snapshot_id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;