Retrieve Details of a Storage Volume Snapshot
/storage/snapshot/{name}
Required Role: To complete this task, you must have the Compute_Monitor
or Compute_Operations
role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.
Request
- application/oracle-compute-v3+json
-
name: string
Multipart name of the snapshot of the storage volume.
-
Cookie: string
The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.
Response
- application/oracle-compute-v3+json
200 Response
-
set-cookie: string
The cookie value is returned if the session is extended
object
-
account(optional):
string
Account to use for snapshots
-
description(optional):
string
Description of this storage snapshot.
-
machineimage_name(optional):
string
The name of the machine image that's used in the boot volume from which this snapshot is taken
-
name(optional):
string
Multipart name of the storage snapshot.
-
parent_volume_bootable(optional):
string
Field indicating whether the parent storage volume is bootable.
-
platform(optional):
string
The OS platform this snapshot is compatible with.
-
property(optional):
string
/oracle/private/storage/snapshot/collocated
indicates that the snapshot is stored in the same physical location as the original storage volume./oracle/public/storage/snapshot/default
indicates that the snapshot aren't stored in the same location as the original storage volume. Instead, they are reduced and stored in the associated Oracle Cloud Infrastructure Object Storage Classic instance.
-
repl_source_region(optional):
string
Not used
-
repl_target_regions(optional):
array repl_target_regions
Not used
-
size(optional):
string
The size of the storage snapshot in bytes.
-
snapshot_id(optional):
string
A unique id for this snapshot auto-generated by the server.
-
snapshot_timestamp(optional):
string
Timestamp of the storage snapshot, generated by storage server. The snapshot will contain data written to the original volume before this time.
-
start_timestamp(optional):
string
Timestamp when the operation is started.
-
status(optional):
string
Current status of the storage snapshot.
-
status_detail(optional):
string
Details about the latest state of the storage volume snapshot.
-
status_timestamp(optional):
string
Indicates the time that the current view of the storage volume snapshot was generated.
-
tags(optional):
array tags
Comma-separated list of strings that describe the storage snapshot.
-
uri(optional):
string
Uniform Resource Identifier
-
volume(optional):
string
The name of the parent storage volume of this storage snapshot.
Examples
cURL Command
The following example shows how to retrieve details of a storage snapshot by submitting a GET
request on the REST resource using cURL. For more information about cURL, see Use cURL.
Enter the command on a single line. Line breaks are used in this example for readability.
curl -X GET -H "Cookie: $COMPUTE_COOKIE" -H "Accept: application/oracle-compute-v3+json" https://api-z999.compute.us0.oraclecloud.com/storage/snapshot/Compute-acme/jack.jones@example.com/vol1/dc14ed57a74c072fd2ec71ed152021eadc10bc868ae17c759f6233ee7317a15d
-
COMPUTE_COOKIE
is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication. -
api-z999.compute.us0.oraclecloud.com
is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests. -
acme
andjack.jones@example.com
are example values. Replaceacme
with the identity domain ID of your Compute Classic account, andjack.jones@example.com
with your user name.
Example of Response Body
The following example shows the response body in JSON format.
{ "status": "completed", "start_timestamp": "2016-07-15T05:03:21Z", "name": "/Compute-acme/jack.jones@example.com/vol1/dc14ed57a74c072fd2ec71ed152021eadc10bc868ae17c759f6233ee7317a15d", "tags": ["vol1"], "description": "Colocated snapshot of vol1", "snapshot_timestamp": "2016-07-15T05:00:14Z", "account": null, "uri": "https://api-z999.compute.us0.oraclecloud.com/storage/snapshot/Compute-acme/jack.jones@example.com/vol1/dc14ed57a74c072fd2ec71ed152021eadc10bc868ae17c759f6233ee7317a15d", "volume": "/Compute-acme/jack.jones@example.com/vol1", "snapshot_id": "dc14ed57a74c072fd2ec71ed152021eadc10bc868ae17c759f6233ee7317a15d", "status_detail": null, "property": "/oracle/private/storage/snapshot/collocated", "machineimage_name": null, "status_timestamp": "2016-04-06T05:03:29Z", "size": "10737418240" }