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

Update the Backup Configuration

post

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

Updates the backup configuration for a service instance.

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

Root Schema : UpdateBackupConfigurationPayload

Type: object

Properties

cloudStorageContainer: Type: string

Oracle Cloud Storage Service container name.
defaultRetention: Type: string

Number of days the incremental backups are retained.
Full backups are retained until their last related incremental backup is available.
If set to null, backups are retained indefinitely or until you manually delete them.
fullBackupSchedule: Type: object fullBackupSchedule

Schedule for the next full backup.
By default, full backups are initiated weekly starting 12 hours after a service instance was created, rounded to the nearest five-minute interval.
incrementalBackupSchedule: Type: object incrementalBackupSchedule

Schedule for the next incremental backup.
By default, incremental backups are initiated every day except the day of a full backup at the same time that full backups are initiated.
Units are the same as for 'fullBackupSchedule'.

Nested Schema : fullBackupSchedule

Type: object

Schedule for the next full backup.
By default, full backups are initiated weekly starting 12 hours after a service instance was created, rounded to the nearest five-minute interval.

Properties

dayOfMonth: Type: string

Non-configurable item. '*' (all days)
dayOfWeek: Type: string

Configurable item
hour: Type: string

Configurable item
minute: Type: string

Configurable item
month: Type: string

Non-configurable item. '*' (all months)
second: Type: string

Non-configurable item. Defaults to '0'
year: Type: string

Non-configurable item. '*' (all years)

Nested Schema : incrementalBackupSchedule

Type: object

Schedule for the next incremental backup.
By default, incremental backups are initiated every day except the day of a full backup at the same time that full backups are initiated.
Units are the same as for 'fullBackupSchedule'.

Properties

dayOfMonth: Type: string

Day Of Month
dayOfWeek: Type: string

Day Of Week
hour: Type: string

hours
minute: Type: string

minutes
month: Type: string

Month
second: Type: string

seconds
year: Type: string

Year

Response

Supported Media Types

application/json

200 Response

success

Body

Root Schema : ViewBackupConfigurationResponse

Type: object

Properties

cloudStorageContainer: Type: string

Required: true

Oracle Cloud Storage Service container name.
defaultRetention: Type: string

Required: true

Number of days the incremental backups are retained.
Full backups are retained until their last related incremental backup is available.
If set to null, backups are retained indefinitely or until you manually delete them.
fullBackupSchedule: Type: object fullBackupSchedule

Required: true

Schedule for the next full backup.
By default, full backups are initiated weekly starting 12 hours after a service instance was created, rounded to the nearest five-minute interval.
incrementalBackupSchedule: Type: object incrementalBackupSchedule

Required: true

Schedule for the next incremental backup.
By default, incremental backups are initiated every day except the day of a full backup at the same time that full backups are initiated.
Units are the same as for 'fullBackupSchedule'.
lastBackupDate: Type: string

Required: true

Date and time that the last backup completed.
Note: If there have been no backups, this attribute is omitted.
nextFullBackupDate: Type: string

Required: true

Scheduled date and time for next full backup.
nextIncrementalBackupDate: Type: string

Required: true

Scheduled date and time for next incremental backup.
percentBackupVolumeUsed: Type: integer

Required: true

Total percent of the backup volume that is currently in use.
totalBackupVolumeUsed: Type: string

Required: true

Total amount, in MBs, of the backup volume that is currently in use.
totalCloudStorageContainerUsed: Type: string

Required: true

Total amount, in MBs, of Cloud Storage Container space that is currently in use.

Nested Schema : fullBackupSchedule

Type: object

Schedule for the next full backup.
By default, full backups are initiated weekly starting 12 hours after a service instance was created, rounded to the nearest five-minute interval.

Properties

dayOfMonth: Type: string

Non-configurable item. '*' (all days)
dayOfWeek: Type: string

Configurable item
hour: Type: string

Configurable item
minute: Type: string

Configurable item
month: Type: string

Non-configurable item. '*' (all months)
second: Type: string

Non-configurable item. Defaults to '0'
year: Type: string

Non-configurable item. '*' (all years)

Nested Schema : incrementalBackupSchedule

Type: object

Properties

dayOfMonth: Type: string

Day Of Month
dayOfWeek: Type: string

Day Of Week
hour: Type: string

hours
minute: Type: string

minutes
month: Type: string

Month
second: Type: string

seconds
year: Type: string

Year

Examples

The following example shows how to update the backup configuration for 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 @backup.json -H "Content-type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/backupconfig

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 document in JSON format.

{
   "fullBackupSchedule":
   {
      "hour":"5",
      "dayOfWeek":"Sun"
   },
   "incrementalBackupSchedule":
   {
      "hour":"3"
   }
}

Example of Response Body

The following example shows the response returned in JSON format with the new values in effect (shown in bold).

{
    "defaultRetention":"30 days",
    "fullBackupSchedule":
    {
        "second":"0",
        "minute":"0",
        "hour":"5",
        "dayOfMonth":"*",
        "month":"*",
        "dayOfWeek":"Sun",
        "year":"*"
    },
    "incrementalBackupSchedule":
    {
       "second":"0",
       "minute":"0",
       "hour":"3",
       "dayOfMonth":"*",
       "month":"*",
       "dayOfWeek":"Mon,Tue,Wed,Thu,Fri,Sat",
       "year":"*"
    },
    "lastBackupDate":"Thu Dec 11 07:25:00 GMT 2014",
    "nextFullBackupDate":"Sun Dec 14 05:00:00 GMT 2014",
    "nextIncrementalBackupDate":"Fri Dec 12 03:00:00 GMT 2014",
    "cloudStorageContainer":"develop-soa/JCSBackup",
    "totalCloudStorageContainerUsed":"0.0MB",
    "totalBackupVolumeUsed":"853.5MB",     
    "percentBackupVolumeUsed":0
}