Retrieves Details of the Specified Backup
/backupservice/v1/backup/{name}
Get the backup specified by the provided multi-part object 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
- application/json
-
name: string
Pattern:
[(^/$|^(/[\w@\.-]+)+$)]{1,255}
Multi-part name of Backup to get
Response
- application/oracle-compute-v3+json
- application/json
200 Response
object
-
backupConfigurationName(optional):
string
Pattern:
(^/$|^(/[\w@\.-]+)+$)
Multi-part name of the backup configuration. -
bootable(optional):
boolean
Default Value:
false
Is the volume this Backup is associated with a bootable volume -
description(optional):
string
Description of the Backup
-
detailedErrorMessage(optional):
string
Read Only:
true
Human readable detailed error message -
errorMessage(optional):
string
Read Only:
true
Human readable error message -
name(optional):
string
Pattern:
(^/$|^(/[\w@\.-]+)+$)
The multi-part name of the object. Object names can contain only alphanumeric characters, hyphens, underscores, @ and periods. Object names are case-sensitive. -
runAsUser(optional):
string
Pattern:
(^/$|^(/[\w@\.-]+)+$)
Any actions on this model will be performed as this user. - shared(optional): boolean
-
snapshotSize(optional):
string
Size of the snapshot
-
snapshotUri(optional):
string(uri)
The snapshot created by this Backup
-
state(optional):
string
Allowed Values:
[ "SUBMITTED", "INPROGRESS", "COMPLETED", "FAILED", "CANCELLING", "CANCELED", "TIMEDOUT", "DELETE_SUBMITTED", "DELETING", "DELETED" ]
State of this resource. -
tagId(optional):
string(uuid)
ID used to tag other cloud resources
-
uri(optional):
string(uri)
Uniform Resource Identifier
-
volumeUri(optional):
string(uri)
The Volume this Backup was created from
401 Response
404 Response
500 Response
Examples
cURL Command
The following example shows how to retrieve details of a backup 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/backupservice/v1/backup/Compute-acme/jack.jones@example.com/vol1-BACKUP-B
-
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.
{ "uri": "https://api-z999.compute.us0.oraclecloud.com:443/backupservice/v1/backup/Compute-acme/jack.jones@example.com/vol1-BACKUP-B", "runAsUser": "/Compute-acme/jack.jones@example.com", "name": "/Compute-acme/jack.jones@example.com/vol1-BACKUP-B", "backupConfigurationName": "/Compute-acme/jack.jones@example.com/backupConfigWeeklyVol2", "volumeUri": "/storage/volume/Compute-acme/jack.jones@example.com/vol1", "errorMessage": "", "detailedErrorMessage": "", "state": "COMPLETED", "description": null, "bootable": false, "shared": false, "snapshotUri": "/storage/snapshot/Compute-acme/jack.jones@example.com/vol1/b2faedfd2d62b5ddbd856bf557235df49e6fcfba5ba91ccddc37893adc73757e", "snapshotSize": "1073741824b", "tagId": "22e6eaf1-3f2b-43b3-9505-63abec384e18" }