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

List Restore Operation History

get

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

Lists the restore operation history for a service instance.

Request

Path Parameters

identityId: Type: string

Required: true

Name of the identity domain for the Oracle Cloud Service account.
serviceId: Type: string

Required: true

ID of the service instance.

Query Parameters

includeFailed

Type: boolean

Includes failed restore operations if set to true.

Default Value

false

Response

Supported Media Types

application/json

202 Response

Body

Root Schema : ViewRestoredBackupsResponse

Type: object

Properties

restoreHistory: Type: array restoreHistory

Groups all completed restoration operations.
restoreInProgress: Type: array restoreInProgress

Groups all restoration operations that are in progress.

Nested Schema : restoreHistory

Type: array

Groups all completed restoration operations.

Items

Type: object RestoreBackupItem

Nested Schema : restoreInProgress

Type: array

Groups all restoration operations that are in progress.

Items

Type: object RestoreBackupItem

Nested Schema : RestoreBackupItem

Type: object

Properties

backupDate

Type: string

Date and time of the backup.

backupId

Type: string

Backup ID.

configDataIncluded

Type: boolean

Boolean flag that specifies whether configuration data was restored (true).

jobId

Type: string

Job ID for the restore operation.

notes

Type: string

Free-form text that provides additional information about the backup.

otdIncluded

Type: boolean

Boolean flag that specifies whether the load balancer was restored (true).

recoveryCompleteDate

Type: string

Date and time that the restoration operation completed.

recoveryStartDate

Type: string

Date and time that the restoration operation started.

staticDataIncluded

Type: boolean

Boolean flag that specifies whether static binary files are included (true) in the restoration operation.

status

Type: string

Status of the restoration operation. Valid values include:

'Completed'
'Failed'
'Restore In Progress'

statusDetails

Type: string

History of system messages. Each message is separated by an ellipses

Examples

The following example shows how to view all restoration operations 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/restoredbackups

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 Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Tue, 02 Sep 2014 14:27:58 GMT
Content-Length: 1595
Content-Type: application/json

Example Response Body

The following shows an example of the response body in JSON format.

{
   "restoreHistory":
   [
      {
         "backupId":"1389925926116",
         "backupDate":"Thu Jan 16 18:32:06 PST 2014",
         "jobId":"505",
         "recoveryStartDate":"Thu Jan 16 18:32:46 PST 2014",
         "recoveryCompleteDate":"Thu Jan 16 18:33:00 PST 2014",
         "status":"Completed",
         "statusDetails":"Stopping WebLogic Server...Stopped WebLogic Server...Restoring the binary 
and configuration data for WebLogic Server administration server on host exampleinstance-wls-1...Restored 
the binary and configuration data for WebLogic Server administration server on host 
exampleinstance-wls-1...Restoring Oracle Traffic Director on host exampleinstance-lb-1...Restored 
Oracle Traffic Director on host exampleinstance-lb-1...Restoring the binary and configuration data for 
WebLogic Server administration server on host  ...Restored the binary and configuration data for 
WebLogic Server administration server on host ...Starting WebLogic Server...Started WebLogic 
Server...Unlocked the WebLogic Server domain configuration... "         
         "staticDataIncluded":false,
         "configDataIncluded":true,
         "otdIncluded":true,
         "notes":"JDK Patching"
      }
   ],
   "restoreInProgress":
      {
         "backupId":"1389926175465",
         "backupDate":"Thu Jan 16 18:36:15 PST 2014",
         "jobId":"606",
         "recoveryStartDate":"Thu Jan 16 18:37:55 PST 2014",
         "status":"In Progress",
         "statusDetails":"Restoration health check passed..."
         "staticDataIncluded":true,
         "configDataIncluded":true,
         "otdIncluded":true,
         "notes":"Notes..."
    }
}