1. REST API for Oracle Java Cloud Service
  2. Tasks
  3. Backups and Restorations

View the Backup Configuration

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backupconfig

Returns the backup configuration for the Oracle Java Cloud Service. The information includes:
  • Schedule for full and incremental backups
  • Date and time of the last successful backup
  • Date and time for the next scheduled backup (both full and incremental)
  • Default retention time for incremental backups and full on-demand backups; full scheduled backups are retained until their last related incremental backup is no longer available, if any
  • State of the backup service for the service instance
  • URI and user name for the object storage container or bucket used to store backups
  • Usage statistics for the object storage container or bucket and backup volume

For complete information about scheduled automated backups, contents of backups, and where backups are stored, see About Backup and Restoration in Administering Oracle Java Cloud Service.

Request

Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : backupconfig-response
Type: object
The response body shows the existing backup configuration for the service instance.
Show Source
Nested Schema : fullBackupSchedule
Type: array
Schedule for the next full backup.
Show Source
Nested Schema : incrementalBackupSchedule
Type: array
Schedule for the next incremental backup.
Show Source
Nested Schema : backupschedule
Type: object
Attributes for fullBackupSchedule and incrementalBackupSchedule.
Show Source

404 Response

Not found. Returned when you try to view the backup configuration when the backup service for the service instance does not exist (that is, the service instance was provisioned with backupDestination set to NONE).
Back to Top

Examples

The following example shows how to view the backup configuration 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/backupconfig

Example of Response Header

The following shows an example of the response header:

HTTP/1.1 200 OK
Date: Mon, 20 Jun 2016 16:55:34 GMT
Transfer-Encoding: chunked
Content-Type: application/json

If the service instance was provisioned with backupDestination set to NONE, the response header would show the following: 

HTTP/1.1 404 Not Found
Date: Sat, 22 Apr 2017 19:32:47 GMT
Content-Type: application/json

Example of Response Body

The following shows an example of the response.

{
    "state": "ENABLED",
    "defaultRetention":"30 days",
    "fullBackupSchedule":
    {
        "second":"0",
        "minute":"20",
        "hour":"14",
        "dayOfMonth":"*",
        "month":"*",
        "dayOfWeek":"Sat",
        "year":"*"
    },
    "incrementalBackupSchedule":
    {
        "second":"0",
        "minute":"20",
        "hour":"14",
        "dayOfMonth":"*",
        "month":"*",
        "dayOfWeek":"Sun,Mon,Tue,Wed,Thu,Fri",
        "year":"*"
    },
    "scheduledBackups":"ALL",
    "extendedRestoreTypes":"NONE",
    "lastBackupDate":"Mon Jun 20 14:20:00 GMT 2016",
    "lastSuccessfulCleanupDate":"Mon Jun 20 14:37:29 GMT 2016",
    "nextFullBackupDate":"Sat Jun 25 14:20:00 GMT 2016",
    "nextIncrementalBackupDate":"Tue Jun 21 14:20:00 GMT 2016",
    "backupDestination":"BOTH",
    "cloudStorageContainer":"Storage-ExampleIdentityDomain\/mybackupcontainer",
    "cloudStorageUser":"username",
    "totalCloudStorageContainerUsed":"46.3MB",
    "totalCloudStorageContainerUsedInBytes":48513508,
    "totalBackupVolumeUsed":"46.3MB",
    "totalBackupVolumeUsedInBytes":48513508,
    "percentBackupVolumeUsed":0.022590864449739456
}

The following example shows another response returned in JSON format, where the backup service is disabled. 

{
    "state": "DISABLED",
    "defaultRetention":"30 days",
    "fullBackupSchedule":
    {
        "second":"0",
        "minute":"20",
        "hour":"14",
        "dayOfMonth":"*",
        "month":"*",
        "dayOfWeek":"Sat",
        "year":"*"
    },
    "incrementalBackupSchedule":
    {
        "second":"0",
        "minute":"20",
        "hour":"14",
        "dayOfMonth":"*",
        "month":"*",
        "dayOfWeek":"Sun,Mon,Tue,Wed,Thu,Fri",
        "year":"*"
    },
    "scheduledBackups":"ALL",
    "extendedRestoreTypes":"NONE",
    "lastBackupDate":"Mon Jun 20 14:20:00 GMT 2016",
    "lastSuccessfulCleanupDate":"Mon Jun 20 14:37:29 GMT 2016",
    "backupDestination":"BOTH",
    "cloudStorageContainer":"Storage-ExampleIdentityDomain\/mybackupcontainer",
    "cloudStorageUser":"username",
    "totalCloudStorageContainerUsed":"46.3MB",
    "totalCloudStorageContainerUsedInBytes":48513508,
    "totalBackupVolumeUsed":"46.3MB",
    "totalBackupVolumeUsedInBytes":48513508,
    "percentBackupVolumeUsed":0.022590864449739456
}
Back to Top