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

Get a Service Backup

get

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

Retrieves an existing backup of a service instance.

Request

Path Parameters

backupId: Type: string

Required: true

ID of the backup to be retrieved.

Query Parameters

includeLinkedDetails

Type: boolean

Includes linked details if set to true.

Default Value

false

Response

Supported Media Types

application/json

200 Response

Accepted

Body

Root Schema : ViewTheBackupResponse.

Type: object

Title: ViewTheBackupResponse.

The response body contains information about the backup

Properties

backupCompleteDate

Type: string

Title: BackupCompleteDate schema.

Date and time that the backup completed.

backupId

Type: string

Title: BackupId schema.

Backup ID.

backupStartDate

Type: string

Title: BackupStartDate schema.

Date and time that the backup started.

dbTag

Type: string

Title: DbTag schema.

This attribute is included only if the database was included in the backup.
ID for the Oracle Cloud Database Service database files. You can use this ID if you need to restore the database. For more information about restoring the Oracle Cloud Database Service, see Restoring from a Specific Backup in Using Oracle Database Cloud - Database as a Service.

expirationDate

Type: null

Title: ExpirationDate schema.

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.

forceScaleInRequiredForRestore

Type: string

Title: forceScaleInRequiredForRestore

Message that indicates the current Oracle SOA Cloud Service instance has Managed Servers configured that are not included in this backup. This value is set to the following error message that provides more information:
JAAS-BR-105: Unable to restore configuration data for managed servers that are not part of the backup. The affected managedsServers are: [managedserver_x, managedserver_y]. Scale in the instance to remove these managed servers' nodes and then try to restore the instance again.
Before you restore the Oracle SOA Cloud Server instance using this backup, perform one of the following steps:
Scale in the service instance to remove the Managed Servers noted in the error message above.
To automatically scale in the Oracle SOA Cloud Service instance, set the 'forceScaleIn' attribute to true when restoring using this backup, as described in Restore a Service Instance

full

Type: boolean

Title: Full schema.

Boolean flag that specifies whether this is a full (true) or incremental (false) backup.
Full backups contain all of the service 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 service instance.

href

Type: string

Title: Href schema.

URI of the backup resource.

initiatedBy

Type: string

Title: InitiatedBy schema.

User account that initiated this operation.

jobHistory

Type: array JobHistory schema.

Title: JobHistory schema.

Groups job history details.

local

Type: boolean

Title: Local schema.

Boolean flag that specifies whether the backup is stored locally, on disk (true), or on Oracle Storage Cloud Service (false).

size

Type: string

Title: Size schema.

Size of the backup, in MBs. For example:

'1011.4MB' (if backup is complete)
'Unknown' (if backup is in progress)

Nested Schema : JobHistory schema.

Type: array

Title: JobHistory schema.

Groups job history details.

Items

Type: object 1 schema.

Title: 1 schema.

Job ID for the backup operation.

Nested Schema : 1 schema.

Type: object

Title: 1 schema.

Job ID for the backup operation.

Properties

completeDate

Type: string

Title: CompleteDate schema.

Date and time the operation completed.

jobId

Type: string

Title: JobId schema.

Job ID for the backup operation.

operation

Type: string

Title: Operation schema.

Type of operation being executed that was executed. For example, backup, delete, download, upload, an d so on.

startDate

Type: string

Title: StartDate schema.

Date and time the operation started.

status

Type: string

Title: Status schema.

Status of the backup. Valid values include:

'Completed'
'Failed'
'Deleted'
'Backup In Progress'
'Upload In Progress'
'Download In Progress'
'Delete In Progress'

statusDetails

Type: string

Title: StatusDetails schema.

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. 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/1390442367140

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: Thu, 04 Feb 2015 16:23:56 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.

{
    "backupId":"1418313410612",
    "jobId":"18758",
    "backupStartDate":"Wed Feb 04 15:56:50 GMT 2015",
    "backupCompleteDate":"Wed Feb 04 16:04:10 GMT 2015",
    "expirationDate":null,
    "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\/ExampleInstance\/backups\/1418313410612",
    "jobHistory":[
    {
        "operation":"upload",
        "jobId":"18767",
        "status":"In Progress",
        "startDate":"Wed Feb 04 16:19:12 GMT 2014"
    },
    {
        "operation":"backup",
        "jobId":"18758",
        "status":"Completed",
        "startDate":"Wed Feb 04 15:56:50 GMT 2015",
        "completeDate":"Wed Feb 04 16:02:10 GMT 2015",
        "statusDetails":"Backup health check passed...
                         Locked the WebLogic Server domain configuration...
                         Started the backup of binary data for WebLogic Server administration server on host exampleinstance-1...
                         Completed the backup of binary data for WebLogic Server administration server on host exampleinstance-1...
                         Started the backup of configuration data for WebLogic Server managed servers on these hosts: exampleinstance-2 exampleinstance-1 ...
                         Completed the backup of configuration data for WebLogic Server managed servers on these hosts: exampleinstance-2 exampleinstance-1...
                         Started the backup of Oracle Traffic Director on host exampleinstance-lb-1... 
                         Completed the backup of Oracle TrafficDirector on host exampleinstance-lb-1...
                         Unlocked the WebLogic Server domain configuration..."
    }
    ],
    "notes":"Automated backup"
}