1. REST API for Lifecycle Management in Oracle API Platform Cloud Service
  2. Tasks
  3. Backup and Restore

View All Backup Operations

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/APICS/instances/{serviceId}/backups

Returns a list of all available backup operations for an API Platform Cloud Service instance, including both scheduled and on-demand backups.

Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

Request

Path Parameters
  • Name of the identity domain for the API Platform Cloud Service account.
  • 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.

Header Parameters

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : Response Body
Type: object
Title: Response Body
Show Source
Nested Schema : backupList Array
Type: array
Title: backupList Array
Array of JSON object elements, with one element for each backup operation.
Show Source
Nested Schema : backupList Array Item
Type: object
Title: backupList Array Item
Show Source
  • Date and time the backup completed. Applies to completed backups only.
  • ID number of the backup operation.
  • Date and time the backup started.
  • Indicates if the database associated with the service instance should also be backed up. This value should be false.
  • Tag that uniquely identifies the backup. Applies to completed backups only.
  • Date and time that the backup deletion completed. This attribute is not valid for backups that are in progress or still available.
  • Date and time the backup expires; null if the backup does not expire.
  • true if this is a full backup; false if this is an incremental backup.
  • Link to retrieve information about this backup.
  • Name of the user who initiated the backup.
  • Job ID of the backup operation.
  • 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.

  • 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 about the backup operation.
  • serviceComponents
    Groups service component details.
  • Size of the backup, in MBs. For example: 1011.4MB (backup complete) or Unknown (backup in-progress).
  • Size, in bytes, of the backup.
  • Status of the backup; one of IN PROGRESS, FAILED, or COMPLETED. Note that there is only one in-progress backup at any given time.
  • Storage container instance containing the backup.
Nested Schema : serviceComponents
Type: array
Groups service component details.
Show Source
Nested Schema : items
Type: object
Show Source

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"
		}]
	}]
}