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

View a Backup

get

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

Returns information about a backup of an Oracle Java 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 About Backup and Restoration in Administering Oracle Java 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 a backup operation on the Oracle Java Cloud Service instance. If false, a database backup was not performed. If true, a database backup was performed.

    Note: This attribute is always false on Oracle Java Cloud Service instances that that are associated with the following database services for the required infrastructure schema:

    • Oracle Autonomous Transaction Processing
    • Oracle Cloud Infrastructure Database (DB system)
    • Oracle Database Exadata Cloud Service

  • An RMAN tag or a timestamp. This attribute is included only if a database backup was performed as part of the Oracle Java Cloud Service instance backup.

    When the associated 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 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.

  • 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.)
  • This attribute is deprecated. See requiresForceScaleFor.

    Note: forceScaleInRequiredForRestore is available for backups of service instances that were created using the deprecated provisioning resource path and endpoint:

    /paas/service/jcs/api/v1.1/instances/{identityDomainId}

  • 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.
  • incrementalBackups
    Groups related incremental backup details. This attribute is returned when you set the ?includeLinkedDetails query parameter to true.
  • 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.
  • requiresForceScaleFor
    One or more host names of nodes on the current Oracle Java Cloud Service instance that are not found in this backup.

    If the service instance contains nodes that are not included in this backup and you are using this backup in a restore operation to undo configuration changes, you can do one of the following:

    • Scale in the service instance before you attempt to use this backup to restore the instance.
    • Set forceScaleIn to true in the restore request to automatically scale in the service instance as part of the restore operation. See Restore a Service Instance.

    Note that requiresForceScaleFor replaces forceScaleInRequiredForRestore (which is deprecated).

    However, forceScaleInRequiredForRestore is available for backups of service instances that were created using the deprecated provisioning resource path and endpoint:

    /paas/service/jcs/api/v1.1/instances/{identityDomainId}

  • serviceComponents
    Groups service component details. Some service instances may return objects in this array.
  • 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, Delete In Progress, or Retired.
  • 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 a backup operation on the Oracle Java Cloud Service instance. If false, a database backup was not performed. If true, a database backup was performed.

    Note: This attribute is always false on Oracle Java Cloud Service instances that that are associated with the following database services for the required infrastructure schema:

    • Oracle Autonomous Transaction Processing
    • Oracle Cloud Infrastructure Database (DB system)
    • Oracle Database Exadata Cloud Service

  • An RMAN tag or a timestamp. This attribute is included only if a database backup was performed as part of the Oracle Java Cloud Service instance backup.

    When the associated 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 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.

  • 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, Delete In Progress, or Retired.

    If the status is Retired, the reason is indicated in the retiredFor value. For example, the database schema password was changed (schPwd).

  • Where service instance backups are stored.
Nested Schema : incrementalBackups
Type: array
Groups related incremental backup details. This attribute is returned when you set the ?includeLinkedDetails query parameter to true.
Show Source
Nested Schema : jobHistory
Type: array
Groups job history details.
Show Source
Nested Schema : requiresForceScaleFor
Type: array
One or more host names of nodes on the current Oracle Java Cloud Service instance that are not found in this backup.

If the service instance contains nodes that are not included in this backup and you are using this backup in a restore operation to undo configuration changes, you can do one of the following:

  • Scale in the service instance before you attempt to use this backup to restore the instance.
  • Set forceScaleIn to true in the restore request to automatically scale in the service instance as part of the restore operation. See Restore a Service Instance.

Note that requiresForceScaleFor replaces forceScaleInRequiredForRestore (which is deprecated).

However, forceScaleInRequiredForRestore is available for backups of service instances that were created using the deprecated provisioning resource path and endpoint:

/paas/service/jcs/api/v1.1/instances/{identityDomainId}

Show Source
Nested Schema : serviceComponents
Type: array
Groups service component details. Some service instances may return objects in this array.
Show Source
Nested Schema : linked-incremental
Type: object
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 a backup operation on the Oracle Java Cloud Service instance. If false, a database backup was not performed. If true, a database backup was performed.

    Note: This attribute is always false on Oracle Java Cloud Service instances that that are associated with the following database services for the required infrastructure schema:

    • Oracle Autonomous Transaction Processing
    • Oracle Cloud Infrastructure Database (DB system)
    • Oracle Database Exadata Cloud Service

  • An RMAN tag or a timestamp. This attribute is included only if a database backup was performed as part of the Oracle Java Cloud Service instance backup.

    When the associated 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 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.

  • 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 host (true), 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, Delete In Progress, or Retired.
  • Where service instance backups are stored.
Nested Schema : jobhistory
Type: object
Show Source
Nested Schema : servicecomponents
Type: object
Some service instances may return objects in the serviceComponents array.
Show Source
  • Service component type. Valid values are JDK, OTD, OTD_JDK, or WLS.
  • Software version of the specified component. For example, 12.1.3.0.5 for WLS, 11.1.1.9.1 for OTD, 1.7.0_91 for OTD_JDK, 1.7.0_91 for JDK.
Back to Top

Examples

The following example shows how to view detailed information for a backup 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/backups/1449345407188

Example of Response Header

The following shows an example of the response header.

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

Example of Response Body

Note: Your output will differ depending on your Oracle Java Cloud Service environment, service instance configuration, and backup configuration.

The following shows an example of the backup response body for a service instance that was created after release 17.4.1.

{
   "backupId":"2c56624c-1dd1-41cf-b1f6-552d29035f76",
   "jobId":"20865168",
   "backupStartDate":"2018-09-14T12:11:21.733+0000",
   "backupCompleteDate":"2018-09-14T12:18:48.458+0000",
   "expirationDate":"2018-09-14T14:11:21.733+0000",
   "initiatedBy":"scheduled",
   "full":true,
   "local":false,
   "localCopy":true,
   "databaseIncluded":true,
   "size":"194.6MB",
   "sizeInBytes":204031914,
   "status":"Completed",
   "storageContainer":"https:\/\/storage_url\/v1\/Storage-accountname\/ExampleInstance",
   "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/2c56624c-1dd1-41cf-b1f6-552d29035f76",
   "jobHistory":[
      {
         "operation":"backup",
         "jobId":"20865168",
         "status":"Completed",
         "startDate":"2018-09-14T12:11:21.733+0000",
         "completeDate":"2018-09-14T12:18:48.458+0000",
         "statusDetails":"An Oracle Storage Cloud Service container is configured...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 configuration data for Oracle Traffic Director admin host exampleinstance-lb-1...
Completed the backup of configuration data for Oracle Traffic Director admin node on exampleinstance-lb-1...
Started the backup of database...Completed the backup of database...Capturing the service metadata...
Completed the backup of service metadata...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",
   "requiresForceScaleFor":"exampleinstance-wls-4",
   "dbTag":"TAG20180914T121502"
}

The following are examples of the backup response body for a service instance that was created before release 17.4.1.

{
    "backupId":"1490596501439",
    "jobId":"1498173",
    "backupStartDate":"2017-03-27T06:35:02.150+0000",
    "backupCompleteDate":"2017-03-27T06:39:48.848+0000",
    "expirationDate":"2017-04-26T06:35:02.150+0000",
    "initiatedBy":"scheduled",
    "full":false,
    "local":false,
    "localCopy":true,
    "databaseIncluded":true,
    "size":"8.7MB",
    "sizeInBytes":9104866,
    "dbTag":"TAG20170327T063741",
    "status":"Completed",
    "storageContainer":"Storage-ExampleIdentityDomain\/JCSBackups",
    "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/1490596501439",
    "jobHistory":[
    {
        "operation":"backup",
        "jobId":"1498173",
        "status":"Completed",
        "startDate":"2017-03-27T06:35:02.150+0000",
        "completeDate":"2017-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",
    "serviceComponents":[
    {
        "type":"OTD_JDK",
        "version":"1.8.0_135"
    },
    {
        "type":"OTD",
        "version":"12.2.1.3.4"
    },
    {
        "type":"JDK",
        "version":"1.8.0_135"
    },
    {
        "type":"WLS",
        "version":"12.2.1.2.170317"
    }]
}

The following example is a full backup with related incremental backups.

{
    "backupId":"1490337301358",
    "jobId":"1465195",
    "backupStartDate":"2017-03-24T06:35:01.980+0000",
    "backupCompleteDate":"2017-03-24T06:39:16.262+0000",
    "expirationDate":"2017-04-23T06:35:01.980+0000",
    "initiatedBy":"scheduled",
    "full":true,
    "local":false,
    "localCopy":true,
    "databaseIncluded":true,
    "size":"3.5MB",
    "sizeInBytes":3675266,
    "dbTag":"TAG20170324T063710",
    "status":"Completed",
    "storageContainer":"Storage-ExampleIdentityDomain\/JCSBackups",
    "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/1490337301358?includeLinkedDetails=true",
    "jobHistory":[
    {
        "operation":"backup",
        "jobId":"1465195",
        "status":"Completed",
        "startDate":"2017-03-24T06:35:01.980+0000",
        "completeDate":"2017-03-24T06:39:16.262+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..."
    }],
    "incrementalBackups":[
    {
        "backupId":"1490596501439",
        "jobId":"1498173",
        "backupStartDate":"2017-03-27T06:35:02.150+0000",
        "backupCompleteDate":"2017-03-27T06:39:48.848+0000",
        "expirationDate":"2017-04-26T06:35:02.150+0000",
        "initiatedBy":"scheduled",
        "full":false,
        "local":false,
        "localCopy":true,
        "databaseIncluded":true,
        "size":"8.7MB",
        "sizeInBytes":9104866,
        "dbTag":"TAG20170327T063741",
        "status":"Completed",
        "storageContainer":"Storage-ExampleIdentityDomain\/JCSBackups",
        "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services
\/jaas\/instances\/ExampleInstance\/backups\/1490596501439",
        "notes":"Automated backup"
    },
    {
        "backupId":"1490423700864",
        "jobId":"1484961",
        "backupStartDate":"2017-03-25T06:35:01.580+0000",
        "backupCompleteDate":"2017-03-25T06:39:50.749+0000",
        "expirationDate":"2017-04-24T06:35:01.580+0000",
        "initiatedBy":"scheduled",
        "full":false,
        "local":false,
        "localCopy":true,
        "databaseIncluded":true,
        "size":"4MB",
        "sizeInBytes":4185730,
        "dbTag":"TAG20170325T063708",
        "status":"Completed",
        "storageContainer":"Storage-ExampleIdentityDomain\/JaaSBackup",
        "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/1490423700864",
        "notes":"Automated backup"
    },
    {
        "backupId":"1490510100509",
        "jobId":"1496567",
        "backupStartDate":"2017-03-26T06:35:01.204+0000",
        "backupCompleteDate":"2017-03-26T06:42:55.134+0000",
        "expirationDate":"2017-04-25T06:35:01.204+0000",
        "initiatedBy":"scheduled",
        "full":false,
        "local":false,
        "localCopy":true,
        "databaseIncluded":true,
        "size":"6.3MB",
        "sizeInBytes":6653458,
        "dbTag":"TAG20170326T063657",
        "status":"Completed",
        "storageContainer":"Storage-ExampleIdentityDomain\/JCSBackups",
        "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/1490510100509",
        "notes":"Automated backup"
    }],
    "notes":"Automated backup",
    "serviceComponents":[
    {
        "type":"OTD_JDK",
        "version":"1.8.0_135"
    },
    {
        "type":"OTD",
        "version":"12.2.1.3.4"},
    {
        "type":"JDK",
        "version":"1.8.0_135"},
    {
        "type":"WLS",
        "version":"12.2.1.2.170317"
    }]
}
Back to Top