REST API for Oracle SOA Cloud Service on Oracle Public Cloud Machine

List Service Backups

get

/api/v1.1/instances/{identityId}/{serviceId}/backups

Returns a list of all the backups of a service instance.

Request

Query Parameters

fullBackupsOnly

Type: boolean

Lists full backups only if set to true.

Default Value

false

includeAll

Type: boolean

Includes all backups if set to true.

Default Value

false

includeCompleteNotes

Type: boolean

Includes all notes if set to true.

Default Value

false

Response

Supported Media Types

application/json

200 Response

Accepted

Body

Root Schema : ViewAllBackupsResponse

Type: object

Properties

backupInProgress: Type: array backupInProgress

Required: true
backups: Type: array backups

Required: true

Nested Schema : backupInProgress

Type: array

Items

Type: object BackupItem

Nested Schema : backups

Type: array

Items

Type: object BackupItem

Nested Schema : BackupItem

Type: object

Properties

backupCompleteDate: Type: string

Required: true

Date and time that the backup completed. This attribute is not valid for backups that are in progress.
backupId: Type: string

Required: true

Backup ID
backupStartDate: Type: string

Required: true

Date and time that the backup started.
dbTag: Type: string

Required: true

RMAN tag that identifies the Oracle Cloud Database Service database files. You can use this tag if you need to restore the database. For more information about restoring the database, see Restoring from a Specific Backup in Using Oracle Database Cloud - Database as a Service.
Note: This attribute is included only if the database was included in the backup.
expirationDate: Type: string

Required: true

Date and time that the backup will be deleted automatically from storage. If set to null, the backup is retained indefinitely or until you manually delete it.
full: Type: boolean

Required: true

Flag that specifies whether this is a full (true) or incremental (false) backup. Full backups contain all of the instance files, including runtime artifacts and files that change infrequently or do not change. Incremental backups contain only the runtime artifacts of each managed VM in the instance.
href: Type: string

Required: true

URI of the backup resource.
initiatedBy: Type: string

Required: true

User account that initiated this operation.
jobId: Type: string

Required: true

Job ID for the backup.
local: Type: boolean

Required: true

Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server (true), or archived and stored remotely on the Oracle Storage Cloud Service container (false).
size: Type: string

Required: true

Size of the backup, in MBs. For example: 1011.4MB (backup complete) or Unknown (backup in-progress).
status: Type: string

Required: true

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.

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. For more information, see Use cURL

cURL Command

curl -i -X GET -u joe@example.com:Welcome1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/backups

Note:: This example uses the URL prefix for the United States ( soacs). For information about the URL prefixes for other regions of the world, see Send Requests.

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 04 Feb 2015 21:24:33 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format, including one completed backup and one in progress:

{
   "backups":[
      {"backupId":"1390442367140",
      "jobId":"202",
      "backupStartDate":"Wed Jul 16 17:59:27 PST 2014",
      "backupCompleteDate":"Wed Jul 16 18:00:59 PST 2014",
      "expirationDate":"Fri Aug 21 17:59:27 PST 2014",
      "initiatedBy":"scheduled",
      "full":true,
      "local":true,
      "localCopy":true,
      "size":"1650.3MB",
      "sizeInBytes":1730501782,
      "dbTag":"TAG20150923T192248"
      "status":"Completed",
      "href":"https:\/\/api-host\/paas\/service\/soa\/api\/instances\/ExampleIdentityDomain\/ExmapleService\/backups\/1390442367140"
       "notes":"Automated backup"},
      { . . . }
   ],
   "backupInProgress":{
      "backupId":"1406814125722",
      "jobId":"450",
      "backupStartDate":"Fri Jul 25 12:33:50 PST 20144",
      "expirationDate":"Sun Aug 31 12:33:50 PST 2014",
      "initiatedBy":"scheduled",
      "full":true,
      "localCopy":true,
      "size":"1650.3MB",
      "sizeInBytes":1730501782,
      "dbTag":"TAG20150923T192248"
      "status":"Backup In Progress",
      "href":"https:\/\/api-host\/paas\/service\/soa\/api\/instances\/ExampleIdentityDomain\/ExampleInstance\/backups\/1406814125722",
      "notes":"Automated backup"}
}