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

Restore from a Backup Point

post

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

Restores a service from a specified backup point.

Request

Supported Media Types

application/json

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.

Body Parameter

The request body defines the details of the restoration request. Bold indicates a required value.

Root Schema : RestoreBackupPayload

The request body defines the details of the restoration request. Bold indicates a required value.

Properties

backupId: Type: string

Required: true

Backup ID
forceScaleIn: Type: boolean

Flag that specifies whether to automatically scale in the Oracle SOA Cloud Service instance if there are Managed Servers configured that are not included in the backup being restored. This value defaults to false, indicating that the service instance should not be scaled in automatically.
If this flag is set to false and the Oracle SOA Cloud Service instance has Managed Servers configured that are not included in the backup being restored, the operation fails and the following error message is returned:
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 service instance to remove these managed servers' nodes and then try to restore the service instance again.
Note: This flag is valid only when restoring configuration data (restoreConfig is set to true).
notes: Type: string

Free-form text to provide additional information about the restoration operation.
pauseOTD: Type: boolean

Flag that specifies whether to pause the load balancer during the restoration process. This value defaults to false.
If set to true, the load balancer is paused and stops forwarding requests to the Managed Servers in the service instance during the restoration process, and responds with an HTTP 503 status code to client requests. After the restoration process completes, the load balancer is restarted.
If pause or restart of the load balancer fails, for example, because the load balancer Administration Server is not available, the restoration process proceeds. The restoration process will fail, however, if the load balancer health check fails.
You should not rely on this feature if any manual tasks are required to be performed once the restoration completes. For more information, see Returning an Oracle SOA Cloud Service Instance to Service After Restoration from a Backup in Using Oracle SOA Cloud Service.
Note: This flag is valid only if the load balancer is enabled.

Response

Supported Media Types

application/json

202 Response

Accepted

Body

Root Schema : RestoreBackupResponse

Type: object

Properties

jobId: Type: string

Job ID for the restoration operation.
operationName: Type: string

Operation performed. This value is set to: restore-backup.
target_uri: Type: string

URI of the backup resource.

Examples

The following example shows how to restore an Oracle SOA Cloud Service instance by submitting a POST request on the REST resource using cURL. For more information, see Use cURL.

cURL Command

curl -i -X POST -u joe@example.com:Welcome1! -d @restore.json -H "Content-Type:application/json" -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 of Request Body

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

{
 "backupId":"1386382930068" 
}

To retrieve the backup ID, see List Service Backups.

Example of Response Header

The following shows an example of the response header:

HTTP/1.1 202 Accepted
Date: Thu, 05 Feb 2015 22:08:03 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following shows an example of the response JSON document.

{
 "operationName":"restore-backup", 
 "job_id":"2001",
 "target_uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/ExmapleIdentityDomain\/ExampleInstance\/restoredbackups\/2001"
}