1. REST API for Oracle SOA Cloud Service
  2. Tasks
  3. Backup and Restore

View All Backups

get

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/backups

Returns information about all backups of an Oracle SOA Cloud Service instance. By default:
  • Full and incremental backups are included. Set the ?fullBackupsOnly query parameter to true to include full backups only.
  • Successful and in-progress backups are returned. Set the ?includeAll query parameter to true to include failed and deleted backups.
  • Notes that are greater than 32 characters in length are truncated. Set the ?includeCompleteNotes query parameter to true to include the complete note contents.

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

Path Parameters
Query Parameters
  • Flag that specifies whether to display full backups only (true) or display both full and incremental backups (false). Defaults to false.
  • Flag that specifies whether to display all backups (true), which includes successful, in-progress, failed, and deleted backups, or display only successful and in-progress backups (false). Defaults to false.
  • Flag that specifies whether to display the complete set of notes for each backup (true) or to truncate notes that are greater than 32 characters (false). Defaults to false.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : viewallbackups-response
Type: object
The response body contains information about all backups.
Show Source
Nested Schema : backupInProgress
Type: array
Groups details of a backup currently in progress, if any.
Show Source
Nested Schema : backups
Type: array
Groups all completed backups.
Show Source
Nested Schema : backups
Type: object
Show Source
  • Date and time that the backup completed. This attribute is not valid for backups that are in progress.
  • Backup ID. You can use the backup ID to manage the specific backup (for example, download or archive).
  • Date and time that the backup started.
  • Flag that specifies whether a database backup was performed as part of the Oracle Java Cloud Service instance backup operation. If false, a database backup was not performed. If true, a database backup was performed.
  • An RMAN tag or a timestamp. The attribute is included only if a database backup was performed as part of the Oracle Java 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.

  • Date and time that the backup deletion completed. This attribute is not valid for backups that are in progress or still available.
  • 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 is null when keepForever was set to true for an on-demand backup.)
  • 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.
  • URI of the backup resource.
  • User account that initiated this operation. If the operation is a scheduled automated backup, the value is scheduled.
  • Job ID for the backup.
  • 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.
  • 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.
  • Free-form text that provides additional information about the backup.
  • serviceComponents
    Groups service component details.
  • Size of the backup, in MBs. For example: 1011.4MB (backup complete) or Unknown (backup in-progress).
  • Size of the backup, in Bytes.
  • Status of the backup. Valid values include: Completed, Failed, Deleted, Backup In Progress, Upload In Progress, Download In Progress, Restore In Progress, or Delete In Progress.
  • Where service instance backups are stored.
Nested Schema : serviceComponents
Type: array
Groups service component details.
Show Source
Nested Schema : servicecomponents
Type: object
Show Source
  • Service component type. Valid values are JDK, OTD, OTD_JDK, or WLS.
  • Software version of the specified component. For example, 12.1.3.0.5 for WLS, 11.1.1.9.1 for OTD, 1.7.0_91 for OTD_JDK, 1.7.0_91 for JDK.
Back to Top

Examples

The following example shows how to view all backups 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

Example of Response Header

The following example shows the response header.

HTTP/1.1 200 OK
Date: Tue, 07 Mar 2021 19:13:31 GMT
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format. Your output will differ depending on your Oracle SOA Cloud Service environment, service instance configuration, and backup configuration. 

{
    "backups":[
    {
        "backupId":"1449332100032",
        "jobId":"8191",
        "backupStartDate":"Sat Dec 05 16:15:00 GMT 2016",
        "backupCompleteDate":"Sat Dec 05 17:36:18 GMT 2016",
        "expirationDate":"Mon Jan 04 16:15:00 GMT 2021",
        "initiatedBy":"scheduled",
        "full":true,
        "local":false,
        "localCopy":true,
        "databaseIncluded":true,
        "size":"15.8MB",
        "sizeInBytes":16557866,
        "dbTag":"TAG20151205T163004",
        "status":"Completed",
        "storageContainer":"Storage-ExampleIdentityDomain\/SOABackups"
        "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/domainName\/services\/SOA\/instances\/ExampleInstance\/backups\/81d4c00e-8520-4e02-87bb-83a9a3df0022",
        "backupId":"1449340039298",
        "jobId":"8213",
        "backupStartDate":"Sat Dec 05 18:27:19 GMT 2016",
        "backupCompleteDate":"Sat Dec 05 18:29:53 GMT 2016",
        "expirationDate":"Mon Jan 04 18:27:19 GMT 2021",
        "initiatedBy":"username",
        "full":true,
        "local":false,
        "localCopy":true,
        "databaseIncluded":false,
        "size":"16MB",
        "sizeInBytes":16792928,
        "status":"Completed",
        "storageContainer":"Storage-ExampleIdentityDomain\/SOABackups"
        "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/domainName\/services\/SOA\/instances\/ExampleInstance\/backups\/81d4c00e-8520-4e02-87bb-83a9a3df0022",
        "backupInProgress":{
        "backupId":"1449346810790",
        "jobId":"8221",
        "backupStartDate":"Sat Dec 05 20:20:10 GMT 2016",
        "expirationDate":"Mon Jan 04 20:20:10 GMT 2021",
        "initiatedBy":"username",
        "full":true,
        "local":true,
        "localCopy":false,
        "databaseIncluded":true,
        "size":"Unknown",
        "sizeInBytes":0,
        "dbTag":"unavailable",
        "status":"Backup In Progress",
        "storageContainer":"Storage-ExampleIdentityDomain\/SOABackups"
        "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/domainName\/services\/SOA\/instances\/ExampleInstance\/backups\/81d4c00e-8520-4e02-87bb-83a9a3df0022
0",
        "notes":"On-demand full with database..."
    }
}
Back to Top