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

View a Backup

get

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/backups/{backupId}

Returns information about a backup of an Oracle SOA Cloud Service instance. By default, information about related backups is excluded. Set the ?includeLinkedDetails query parameter to true to include information about related backups.

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
Query Parameters
  • Flag that specifies whether to include information (true) or exclude information about related backups (false). When set to true:
    • For a full backup, includes information about all incremental backups performed since the last full backup.
    • For an incremental backup, includes information about the previous full backup.
    Defaults to false, excluding information about related backups.
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 : viewbackup-response
Type: object
The response body contains information about a backup.
Show Source
  • Date and time that the backup completed.
  • Backup ID. You can use the backup ID to manage the specific backup (for example, download or archive).
  • Date and time that the backup started.
  • Flag that specifies whether a database backup was performed as part of the Oracle SOA Cloud Service instance backup operation. If false, a database backup was not performed. If true, a database backup was performed.
  • An RMAN tag or a timestamp. This attribute is included only if a database backup was performed as part of the Oracle SOA Cloud Service instance backup.

    When the associated Database Cloud Service database deployment is hosting a single-instance database, the attribute value is the RMAN tag that identifies the specific database files backed up. When the associated Database Cloud Service database deployment is hosting an Oracle Real Application Clusters (RAC) database, the attribute value is the timestamp of the database backup. In either case, you use the attribute value to restore the database, if necessary. For information about restoring the database files, see Restoring from a Specific Backup or Restoring to a Specific Point in Time in Administering Oracle Database Cloud Service.

  • 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 that the backup will be deleted automatically from storage. If the value is null, the backup is retained indefinitely or until you manually delete it. (Value is null when keepForever was set to true for an on-demand backup.)
  • Flag that specifies whether this is a full (true) or incremental (false) backup. A full backup contains all the runtime artifacts required to restore the service instance configuration data. An incremental backup contains changes to configuration data on all virtual machines since the last scheduled full backup.
  • fullBackup
    Related full backup details. This attribute is returned when you set the ?includeLinkedDetails query parameter to true.
  • URI of the backup resource.
  • User account that initiated this operation. If the operation is a scheduled automated backup, the value is scheduled.
  • jobHistory
    Groups job history details.
  • Job ID for the backup.
  • Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server host (true), or archived and stored remotely (false). The remote storage is the specified object storage container or bucket.
  • Flag that specifies whether the local copy of a backup is maintained for a backup that has been uploaded to remote storage. The remote storage is the specified object storage container or bucket.
  • Free-form text that provides additional information about the backup.
  • Size of the backup, in MBs. For example: 1011.4MB (backup complete) or Unknown (backup in-progress).
  • Size of the backup, in Bytes.
  • Status of the backup. Valid values include: Completed, Failed, Deleted, Backup In Progress, Upload In Progress, Download In Progress, Restore In Progress, or Delete In Progress.
  • Where service instance backups are stored.
Nested Schema : fullBackup
Type: object
Related full backup details. This attribute is returned when you set the ?includeLinkedDetails query parameter to true.
Show Source
  • Date and time that the backup completed.
  • Backup ID. You can use the backup ID to manage the specific backup (for example, download or archive).
  • Date and time that the backup started.
  • Flag that specifies whether a database backup was performed as part of the Oracle SOA Cloud Service instance backup operation. If false, a database backup was not performed. If true, a database backup was performed.
  • An RMAN tag or a timestamp. This attribute is included only if a database backup was performed as part of the Oracle SOA Cloud Service instance backup.

    When the associated Database Cloud Service database deployment is hosting a single-instance database, the attribute value is the RMAN tag that identifies the specific database files backed up. When the associated Database Cloud Service database deployment is hosting an Oracle Real Application Clusters (RAC) database, the attribute value is the timestamp of the database backup. In either case, you use the attribute value to restore the database, if necessary. For information about restoring the database files, see Restoring from a Specific Backup or Restoring to a Specific Point in Time in Administering Oracle Database Cloud Service.

  • Date and time that the backup will be deleted automatically from storage. If the value is null, the backup is retained indefinitely or until you manually delete it. (Value is null when keepForever was set to true for an on-demand backup.)
  • Flag that specifies whether this is a full (true) or incremental (false) backup. A full backup contains all the runtime artifacts required to restore the service instance configuration data. An incremental backup contains changes to configuration data on all virtual machines since the last scheduled full backup.
  • URI of the backup resource.
  • User account that initiated this operation. If the operation is a scheduled automated backup, the value is scheduled.
  • Job ID for the backup.
  • Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server (true) host, or archived and stored remotely (false) in the specified object storage container or bucket.
  • Flag that specifies whether the local copy of a backup is maintained for a backup that has been uploaded to remote storage. The remote storage is the specified object storage container or bucket.
  • Free-form text that provides additional information about the backup.
  • Size of the backup, in MBs. For example: 1011.4MB (backup complete) or Unknown (backup in-progress).
  • Size of the backup, in Bytes.
  • Status of the backup. Valid values include: Completed, Failed, Deleted, Backup In Progress, Upload In Progress, Download In Progress, Restore In Progress, or Delete In Progress.
  • Where service instance backups are stored.
Nested Schema : jobHistory
Type: array
Groups job history details.
Show Source
Nested Schema : jobhistory
Type: object
Show Source
Back to Top

Examples

The following example shows how to view detailed information for a backup 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/backups/81d4c00e-8520-4e02-87bb-83a9a3df0022

Example of Response Header

The following example shows the response header.

HTTP/1.1 200 OK
Date: Mon, 27 Mar 2021 17:24:50 GMT
Content-Type: application/json

Example of Response Body

The following shows the contents of the response body in JSON format for a backup. Your output will differ depending on your service environment, service instance configuration, and backup configuration.

{
    "backupId":"1490596501439",
    "jobId":"1498173",
    "backupStartDate":"2021-03-27T06:35:02.150+0000",
    "backupCompleteDate":"2021-03-27T06:39:48.848+0000",
    "expirationDate":"2021-04-26T06:35:02.150+0000",
    "initiatedBy":"scheduled",
    "full":false,
    "local":false,
    "localCopy":true,
    "databaseIncluded":true,
    "size":"8.7MB",
    "sizeInBytes":9104866,
    "dbTag":"TAG20210327T063741",
    "status":"Completed",
    "storageContainer":"Storage-ExampleIdentityDomain\/SOABackups",
    "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/domainName\/services\/SOA\/instances\/ExampleInstance\/backups\/1490596501439",
    "jobHistory":[
    {
        "operation":"backup",
        "jobId":"1498173",
        "status":"Completed",
        "startDate":"2021-03-27T06:35:02.150+0000",
        "completeDate":"2021-03-27T06:39:48.848+0000",
        "statusDetails":"Backup health check passed...Locked the WebLogic Server domain configuration...Started the backup of configuration data for WebLogic administration server and managed servers...
        Completed the backup of configuration data for WebLogic administration server and managed servers...Started the backup of database...Completed the backup of database...Unlocked the WebLogic Server domain configuration...
        Uploading the backup archive to the Oracle Storage Cloud Service container...Uploaded the object to the Oracle Storage Cloud Service container..."
    }],
    "notes":"Automated backup",
    
}
Back to Top