View All Restoration Operations
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/restoredbackups
By default, only successful restoration operations are included. Set the ?includeFailed
query parameter to true
to include both successful and failed restoration operations.
Request
-
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
serviceId: string
Name of the Oracle Java Cloud Service instance.
-
includeFailed(optional): boolean
Flag that specifies whether to include (
true
) or exclude (false
) failed restoration operations. Defaults tofalse
.
-
Authorization: string
Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle Java Cloud Service account.
Response
- application/json
200 Response
object
-
restoreHistory(optional):
array restoreHistory
Groups all completed restoration operations.
-
restoreInProgress(optional):
array restoreInProgress
Groups details of a restoration operation currently in progress, if any.
array
object
-
backupDate(optional):
string
Date and time of the backup.
-
backupId(optional):
string
Backup ID.
-
configDataIncluded(optional):
boolean
Flag that specifies configuration data was restored (
true
). -
databaseIncluded(optional):
boolean
Flag that specifies whether the database files for the associated database deployment were included in the Oracle Java Cloud Service instance restoration operation. If
false
, the database files were not included. Iftrue
, the files were included.Note: This attribute is always
false
on Oracle Java Cloud Service instances that that are associated with the following database services for the required infrastructure schema:- Oracle Autonomous Transaction Processing
- Oracle Cloud Infrastructure Database (DB system)
- Oracle Database Exadata Cloud Service
-
jobId(optional):
string
Job ID for the restore operation.
-
notes(optional):
string
Free-form text that provides additional information about the restoration operation.
-
otdIncluded(optional):
boolean
Flag that specifies whether the load balancer was restored (
true
). If OTD is not provisioned or was not provisioned at the time of the backup, the value isfalse
. -
recoveryCompleteDate(optional):
string
Date and time that the restoration operation completed. This information is not displayed for restorations that are still in progress.
-
recoveryStartDate(optional):
string
Date and time that the restoration operation started.
-
restoreBinariesType(optional):
string
Type of binary restoration, whether binary restoration was invoked explicitly (
resetBinaries
istrue
) or as part of a patch rollback. Valid values include:reset
orrollback
.If
staticDataIncluded
istrue
, the exact static restore type is displayed. -
staticDataIncluded(optional):
boolean
Flag that specifies the static binary files were not included (
false
) or included (true
) in the restoration operation. -
status(optional):
string
Status of the operation. Valid values include:
Completed
,Failed
, orIn Progress
. -
statusDetails(optional):
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 Java 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/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/restoredbackups
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK
Date: Tue, 08 Dec 2015 23:44:33 GMT
Transfer-Encoding: chunked
Content-Type: application/json
Example of Response Body
The following shows an example of the response body in JSON format. Your output will differ depending on your Oracle Java Cloud Service environment, service instance configuration, and backup configuration.
{
"restoreHistory":[
{
"backupId":"1449332100032",
"backupDate":"Sat Dec 05 16:15:00 GMT 2015",
"jobId":"8226",
"recoveryStartDate":"Sat Dec 05 23:39:02 GMT 2015",
"recoveryCompleteDate":"Sat Dec 05 23:57:53 GMT 2015",
"status":"Completed",
"statusDetails":"The backup archive already exists in the block storage and does not need to be downloaded from the Oracle Storage Cloud Service container...
Submitted the restoration precheck for remote execution...
Restoration precheck passed...Disabled the load balancer...Submitted the restoration for remote execution...
These managed servers were added after the backup was created: ['exampleinstance-wls-3']. The instance will be scaled in with force=true to remove these managed servers...Stopping WebLogic Server...
Stopped WebLogic Server...Restoring the configuration data for WebLogic Server administration server on host exampleinstance-wls-1...
Restored the 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 configuration data for WebLogic Server administration server on host exampleinstance-wls-2...
Restored the configuration data for WebLogic Server administration server on host exampleinstance-wls-2...Starting WebLogic Server...
Started WebLogic Server...Unlocked the WebLogic Server domain configuration...
Completed the restoration...Enabled the load balancer...Validated the load balancer",
"staticDataIncluded":false,
"configDataIncluded":true,
"otdIncluded":true,
"databaseIncluded":false
}],
"restoreInProgress":
{
"backupId":"1449340039298",
"backupDate":"Sat Dec 05 18:27:19 GMT 2015",
"jobId":"8386",
"recoveryStartDate":"Tue Dec 08 23:43:49 GMT 2015",
"status":"In Progress",
"staticDataIncluded":true,
"restoreBinariesType":"reset",
"configDataIncluded":true,
"otdIncluded":true,
"databaseIncluded":false,
"notes":"Restore and reset binary files"
}
}