1. REST API for Oracle SOA Cloud Service
  2. Tasks
  3. Backup and Restore

View the Backup Configuration

get

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceId}/backupconfig

Returns the backup configuration for the Oracle SOA 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 Back Up and Restore an Oracle SOA Cloud Service Instance in Administering Oracle SOA 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
  • Location of the service instance backups. This attribute is displayed for PAAS service level instances only.

    The default value is BOTH. This means all service instance backups are stored on disk (in a volume attached to the nodes) and in the object storage container or bucket that is specified in cloudStorageContainer.

  • URI of the object storage container or bucket where service instance backups are stored.
  • User name for the object storage user.
  • Number of days incremental backups and full on-demand backups are retained. If set to null, backups are retained indefinitely or until you manually delete them.

    Full scheduled backups are retained until their last related incremental backup is no longer available, if any.

  • Timestamp when backups were disabled automatically due to repeated failure. If backups were disabled by the user, then the response will not include this field.
  • Flag that specifies whether a scheduled Oracle SOA Cloud Service instance backup is to include a backup of the associated Oracle Database Cloud Service database deployment.

    The attribute is only displayed when the value is true (that is, when backups of associated database deployments are disabled). However, this may change in the future.

  • Only value is NONE. This means that restoration of backups is supported only by using a backup ID.
  • fullBackupSchedule
    Schedule for the next full backup.
  • incrementalBackupSchedule
    Schedule for the next incremental backup.
  • Scheduled date and time for next full backup.

    This attribute is not available when the state of the backup service is disabled for the service instance.

  • Scheduled date and time for next incremental backup.

    This attribute is not available when the state of the backup service is disabled for the service instance.

  • Type of scheduled backups.
    • ALL: Both full and incremental scheduled backups are enabled.
    • DISABLED: Backups are disabled. See disabledOnError for the reason.
  • State of the backup service for the service instance. For example, ENABLED or DISABLED.
  • Total amount (in GBs) of the backup volume that is currently in use.
  • Total amount (in Bytes) of the backup volume that is currently in use.
  • The total amount (in GBs) of the object storage container or bucket space that is currently in use.
  • The total amount (in Bytes) of the object storage container or bucket space that is currently in use.
Nested Schema : fullBackupSchedule
Type: object
Schedule for the next full backup.
Show Source
Nested Schema : incrementalBackupSchedule
Type: object
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 SOA 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/{domainName}/services/SOA/instances/ExampleInstance/backupconfig

Example of Response Header

The following example shows the response header:

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

Example of Response Body

The following example shows 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",
    "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,
    
}

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",
    "backupDestination":"BOTH",
    "cloudStorageContainer":"Storage-ExampleIdentityDomain\/mybackupcontainer",
    "cloudStorageUser":"username",
    "totalCloudStorageContainerUsed":"46.3MB",
    "totalCloudStorageContainerUsedInBytes":48513508,
    "totalBackupVolumeUsed":"46.3MB",
    "totalBackupVolumeUsedInBytes":48513508,
    6
}
Back to Top