View a Backup
/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/backups/{backupId}
?includeLinkedDetails
query parameter to true
to include information about related backups.For complete information about scheduled automated backups, contents of backups, and where backups are stored, see Back Up and Restore an Oracle SOA Cloud Service Instance in Administering Oracle SOA Cloud Service.
Request
-
backupId: string
Backup ID. To retrieve the backup ID, see View All Backups.
-
domainName: string
Identity domain ID for the Oracle SOA Cloud Service account.
-
serviceName: string
Name of the Oracle SOA Cloud Service instance.
-
includeLinkedDetails(optional): boolean
Flag that specifies whether to include information (
true
) or exclude information about related backups (false
). When set totrue
:- For a full backup, includes information about all incremental backups performed since the last full backup.
- For an incremental backup, includes information about the previous full backup.
false
, excluding information about related backups.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle SOA Cloud Service account.
Response
- application/json
200 Response
object
-
backupCompleteDate:
string
Date and time that the backup completed.
-
backupId:
string
Backup ID. You can use the backup ID to manage the specific backup (for example, download or archive).
-
backupStartDate:
string
Date and time that the backup started.
-
databaseIncluded:
boolean
Flag that specifies whether a database backup was performed as part of the Oracle SOA Cloud Service instance backup operation. If
false
, a database backup was not performed. Iftrue
, a database backup was performed. -
dbTag:
string
An RMAN tag or a timestamp. This attribute is included only if a database backup was performed as part of the Oracle SOA Cloud Service instance backup.
When the associated Database Cloud Service database deployment is hosting a single-instance database, the attribute value is the RMAN tag that identifies the specific database files backed up. When the associated Database Cloud Service database deployment is hosting an Oracle Real Application Clusters (RAC) database, the attribute value is the timestamp of the database backup. In either case, you use the attribute value to restore the database, if necessary. For information about restoring the database files, see Restoring from a Specific Backup or Restoring to a Specific Point in Time in Administering Oracle Database Cloud Service.
-
deletedOnDate:
string
Date and time that the backup deletion completed. This attribute is not valid for backups that are in progress or still available.
-
expirationDate:
string
Date and time that the backup will be deleted automatically from storage. If the value is
null
, the backup is retained indefinitely or until you manually delete it. (Value isnull
whenkeepForever
was set totrue
for an on-demand backup.) -
full:
boolean
Flag that specifies whether this is a full (
true
) or incremental (false
) backup. A full backup contains all the runtime artifacts required to restore the service instance configuration data. An incremental backup contains changes to configuration data on all virtual machines since the last scheduled full backup. -
fullBackup:
object fullBackup
Related full backup details. This attribute is returned when you set the
?includeLinkedDetails
query parameter totrue
. -
href:
string
URI of the backup resource.
-
initiatedBy:
string
User account that initiated this operation. If the operation is a scheduled automated backup, the value is
scheduled
. -
jobHistory:
array jobHistory
Groups job history details.
-
jobId:
string
Job ID for the backup.
-
local:
boolean
Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server host (
true
), or archived and stored remotely (false
). The remote storage is the specified object storage container or bucket. -
localCopy:
boolean
Flag that specifies whether the local copy of a backup is maintained for a backup that has been uploaded to remote storage. The remote storage is the specified object storage container or bucket.
-
notes:
string
Free-form text that provides additional information about the backup.
-
size:
string
Size of the backup, in MBs. For example:
1011.4MB
(backup complete) orUnknown
(backup in-progress). -
sizeInBytes:
integer
Size of the backup, in Bytes.
-
status:
string
Status of the backup. Valid values include:
Completed
,Failed
,Deleted
,Backup In Progress
,Upload In Progress
,Download In Progress
,Restore In Progress
, orDelete In Progress
. -
storageContainer:
string
Where service instance backups are stored.
object
?includeLinkedDetails
query parameter to true
.-
backupCompleteDate(optional):
string
Date and time that the backup completed.
-
backupId(optional):
string
Backup ID. You can use the backup ID to manage the specific backup (for example, download or archive).
-
backupStartDate(optional):
string
Date and time that the backup started.
-
databaseIncluded(optional):
boolean
Flag that specifies whether a database backup was performed as part of the Oracle SOA Cloud Service instance backup operation. If
false
, a database backup was not performed. Iftrue
, a database backup was performed. -
dbTag(optional):
string
An RMAN tag or a timestamp. This attribute is included only if a database backup was performed as part of the Oracle SOA Cloud Service instance backup.
When the associated Database Cloud Service database deployment is hosting a single-instance database, the attribute value is the RMAN tag that identifies the specific database files backed up. When the associated Database Cloud Service database deployment is hosting an Oracle Real Application Clusters (RAC) database, the attribute value is the timestamp of the database backup. In either case, you use the attribute value to restore the database, if necessary. For information about restoring the database files, see Restoring from a Specific Backup or Restoring to a Specific Point in Time in Administering Oracle Database Cloud Service.
-
expirationDate(optional):
string
Date and time that the backup will be deleted automatically from storage. If the value is
null
, the backup is retained indefinitely or until you manually delete it. (Value isnull
whenkeepForever
was set totrue
for an on-demand backup.) -
full(optional):
boolean
Flag that specifies whether this is a full (
true
) or incremental (false
) backup. A full backup contains all the runtime artifacts required to restore the service instance configuration data. An incremental backup contains changes to configuration data on all virtual machines since the last scheduled full backup. -
href(optional):
string
URI of the backup resource.
-
initiatedBy(optional):
string
User account that initiated this operation. If the operation is a scheduled automated backup, the value is
scheduled
. -
jobId(optional):
string
Job ID for the backup.
-
local(optional):
boolean
Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server (
true
) host, or archived and stored remotely (false
) in the specified object storage container or bucket. -
localCopy(optional):
boolean
Flag that specifies whether the local copy of a backup is maintained for a backup that has been uploaded to remote storage. The remote storage is the specified object storage container or bucket.
-
notes(optional):
string
Free-form text that provides additional information about the backup.
-
size(optional):
string
Size of the backup, in MBs. For example:
1011.4MB
(backup complete) orUnknown
(backup in-progress). -
sizeInBytes(optional):
integer
Size of the backup, in Bytes.
-
status(optional):
string
Status of the backup. Valid values include:
Completed
,Failed
,Deleted
,Backup In Progress
,Upload In Progress
,Download In Progress
,Restore In Progress
, orDelete In Progress
. -
storageContainer(optional):
string
Where service instance backups are stored.
object
-
completeDate(optional):
string
Date and time that the operation completed.
-
jobId(optional):
string
Job ID for the backup.
-
operation(optional):
string
Type of operation that was executed. For example,
backup
,delete
,upload
,download
, and so on. -
startDate(optional):
string
Date and time the operation started.
-
status(optional):
string
Status of the backup. Valid values include:
Completed
,Failed
,Deleted
,Backup In Progress
,Upload In Progress
,Download In Progress
,Restore In Progress
, orDelete In Progress
. -
statusDetails(optional):
string
History of system messages. Each message is separated by an ellipses
{...}
.
Examples
The following example shows how to view detailed information for a backup for an Oracle SOA Cloud Service instance by submitting a GET request on the REST resource using cURL.
Note: The command in this example uses the URL structure https://rest_server_url/resource-path
, where rest_server_url
is the REST server to contact for your identity domain (or Cloud account). See Send Requests.
cURL Command
curl -i -X GET -u username:Password! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/ExampleInstance/backups/81d4c00e-8520-4e02-87bb-83a9a3df0022
Example of Response Header
The following example shows the response header.
HTTP/1.1 200 OK
Date: Mon, 27 Mar 2021 17:24:50 GMT
Content-Type: application/json
Example of Response Body
The following shows the contents of the response body in JSON format for a backup. Your output will differ depending on your service environment, service instance configuration, and backup configuration.
{
"backupId":"1490596501439",
"jobId":"1498173",
"backupStartDate":"2021-03-27T06:35:02.150+0000",
"backupCompleteDate":"2021-03-27T06:39:48.848+0000",
"expirationDate":"2021-04-26T06:35:02.150+0000",
"initiatedBy":"scheduled",
"full":false,
"local":false,
"localCopy":true,
"databaseIncluded":true,
"size":"8.7MB",
"sizeInBytes":9104866,
"dbTag":"TAG20210327T063741",
"status":"Completed",
"storageContainer":"Storage-ExampleIdentityDomain\/SOABackups",
"href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/domainName\/services\/SOA\/instances\/ExampleInstance\/backups\/1490596501439",
"jobHistory":[
{
"operation":"backup",
"jobId":"1498173",
"status":"Completed",
"startDate":"2021-03-27T06:35:02.150+0000",
"completeDate":"2021-03-27T06:39:48.848+0000",
"statusDetails":"Backup health check passed...Locked the WebLogic Server domain configuration...Started the backup of configuration data for WebLogic administration server and managed servers...
Completed the backup of configuration data for WebLogic administration server and managed servers...Started the backup of database...Completed the backup of database...Unlocked the WebLogic Server domain configuration...
Uploading the backup archive to the Oracle Storage Cloud Service container...Uploaded the object to the Oracle Storage Cloud Service container..."
}],
"notes":"Automated backup",
}