View All Backup Operations
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/APICS/instances/{serviceId}/backups
Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.
Request
-
identityDomainId: string
Name of the identity domain for the API Platform Cloud Service account.
-
serviceId: string
Name of the API Platform Cloud Service instance.
Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.
-
Authorization: string
Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
Response
- application/json
200 Response
object
Response Body
-
backupList:
array backupList Array
Title:
backupList Array
Array of JSON object elements, with one element for each backup operation.
array
backupList Array
-
[0]:
object backupList Array Item
Title:
backupList Array Item
object
backupList Array Item
-
backupCompleteDate:
string
Date and time the backup completed. Applies to completed backups only.
-
backupId:
string
ID number of the backup operation.
-
backupStartDate:
string
Date and time the backup started.
-
databaseIncluded:
boolean
Indicates if the database associated with the service instance should also be backed up. This value should be
false
. -
dbTag:
string
Tag that uniquely identifies the backup. Applies to completed backups only.
-
deletedOnDate:
string
Date and time that the backup deletion completed. This attribute is not valid for backups that are in progress or still available.
-
expirationDate:
null
Date and time the backup expires;
null
if the backup does not expire. -
full:
boolean
true
if this is a full backup;false
if this is an incremental backup. -
href:
string
Link to retrieve information about this backup.
-
initiatedBy:
string
Name of the user who initiated the backup.
-
jobId:
string
Job ID of the backup operation.
-
local:
boolean
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 (false
).On Oracle Public Cloud, the remote storage is the specified Oracle Storage Cloud Service container.
-
localCopy:
boolean
Flag that specifies whether the local copy of a backup is maintained for a backup that has been uploaded to remote storage.
On Oracle Public Cloud, the remote storage is the specified Oracle Storage Cloud Service container.
-
notes:
string
Notes about the backup operation.
-
serviceComponents:
array serviceComponents
Groups service component details.
-
size:
string
Size of the backup, in MBs. For example:
1011.4MB
(backup complete) orUnknown
(backup in-progress). -
sizeInBytes:
integer
Size, in bytes, of the backup.
-
status:
string
Status of the backup; one of
IN PROGRESS
,FAILED
, orCOMPLETED
. Note that there is only one in-progress backup at any given time. -
storageContainer:
string
Storage container instance containing the backup.
object
-
type:
string
Service component type. Valid values are
JDK
,OTD
,OTD_JDK
, orWLS
. -
version:
string
Software version of the specified component.
Examples
The following example shows how to view all Oracle API Platform Cloud Service backups by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Examples.
curl -i -X GET -u apicsadmin:password -H "Content-Type: application/json" https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics/backups
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Date: Wed, 23 Nov 2016 11:06:47 GMT Transfer-Encoding: chunked Content-Type: application/json X-ORACLE-DMS-ECID: 7077e58cc81a37d2:-4cd90f8:15878a7e3f0:-8000-0000000000005fb2 X-Frame-Options: DENY Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD Access-Control-Allow-Headers: Content-Type, api_key, Authorization Access-Control-Allow-Origin: *
Example of Response Body
The following example shows the contents of the response body in JSON format, including detailed information about all service backups.
{ "backups": [{ "backupId": "1479898800355", "jobId": "26358", "backupStartDate": "2016-11-23T11:00:00.454+0000", "backupCompleteDate": "2016-11-23T11:04:34.559+0000", "expirationDate": null, "initiatedBy": "apicsadmin", "full": true, "local": false, "localCopy": true, "databaseIncluded": true, "size": "1.5MB", "sizeInBytes": 1604950, "dbTag": "JAAS20161123T110009", "status": "Completed", "storageContainer": "Storage-apics/APICSBackup", "href": "https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics/backups/1479898800355", "notes": "On-demand full backup request.", "serviceComponents": [{ "type": "JDK", "version": "1.8.0_102" }, { "type": "OTD", "version": "12.2.1.0.160719" }, { "type": "OTD_JDK", "version": "1.8.0_102" }, { "type": "WLS", "version": "12.2.1.0.160719" }] }] }