Jump to

• Request
• Response
• Examples

View All Backups

get

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

Returns information about all backups of an Oracle Java Cloud Service instance. By default:

• Full and incremental backups are included. Set the ?fullBackupsOnly query parameter to true to include full backups only.
• Successful and in-progress backups are returned. Set the ?includeAll query parameter to true to include failed, deleted, and retired backups.
• Notes that are greater than 32 characters in length are truncated. Set the ?includeCompleteNotes query parameter to true to include the complete note contents.

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

• identityDomainId: string
  Identity domain ID for the Oracle Java Cloud Service account.
• serviceId: string
  Name of the Oracle Java Cloud Service instance.

Query Parameters

• fullBackupsOnly(optional): boolean
  Flag that specifies whether to display full backups only (true) or display both full and incremental backups (false). Defaults to false.
• includeAll(optional): boolean
  Flag that specifies whether to display all backups (true), which includes successful, in-progress, failed, and deleted backups, or display only successful and in-progress backups (false). Defaults to false.
• includeCompleteNotes(optional): boolean
  Flag that specifies whether to display the complete set of notes for each backup (true) or to truncate notes that are greater than 32 characters (false). Defaults to false.

Header Parameters

• Authorization: string
  Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Java Cloud Service account.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Body ()

Root Schema : viewallbackups-response

Type: object

The response body contains information about all backups.

Show Source

• backupInProgress(optional): array backupInProgress
  Groups details of a backup currently in progress, if any.
• backups(optional): array backups
  Groups all completed backups.

{
    "description":"The response body contains information about all backups.",
    "properties":{
        "backups":{
            "type":"array",
            "description":"Groups all completed backups.",
            "items":{
                "$ref":"#/definitions/backups"
            }
        },
        "backupInProgress":{
            "type":"array",
            "description":"Groups details of a backup currently in progress, if any.",
            "items":{
                "$ref":"#/definitions/backups"
            }
        }
    }
}

Nested Schema : backupInProgress

Type: array

Groups details of a backup currently in progress, if any.

Show Source

• Array of: object backups

{
    "type":"array",
    "description":"Groups details of a backup currently in progress, if any.",
    "items":{
        "$ref":"#/definitions/backups"
    }
}

Nested Schema : backups

Type: array

Groups all completed backups.

Show Source

• Array of: object backups

{
    "type":"array",
    "description":"Groups all completed backups.",
    "items":{
        "$ref":"#/definitions/backups"
    }
}

Nested Schema : backups

Type: object

Show Source

• backupCompleteDate(optional): string
  Date and time that the backup completed. This attribute is not valid for backups that are in progress.
• backupId(optional): string
  Backup ID. You can use the backup ID to manage the specific backup (for example, download or archive).
• backupStartDate(optional): string
  Date and time that the backup started.
• databaseIncluded(optional): boolean
  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

• dbTag(optional): string
  An RMAN tag or a timestamp. The 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.

• deletedOnDate(optional): string
  Date and time that the backup deletion completed. This attribute is not valid for backups that are in progress or still available.
• expirationDate(optional): string
  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.)
• full(optional): boolean
  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.
• href(optional): string
  URI of the backup resource.
• initiatedBy(optional): string
  User account that initiated this operation. If the operation is a scheduled automated backup, the value is scheduled.
• jobId(optional): string
  Job ID for the backup.
• local(optional): boolean
  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.
• localCopy(optional): boolean
  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.
• notes(optional): string
  Free-form text that provides additional information about the backup.
• requiresForceScaleFor(optional): array 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(optional): array serviceComponents
  Groups service component details. Some service instances may return objects in this array.
• size(optional): string
  Size of the backup, in MBs. For example: 1011.4MB (backup complete) or Unknown (backup in-progress).
• sizeInBytes(optional): integer
  Size of the backup, in Bytes.
• status(optional): string
  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).

• storageContainer(optional): string
  Where service instance backups are stored.

{
    "properties":{
        "backupId":{
            "type":"string",
            "description":"Backup ID. You can use the backup ID to manage the specific backup (for example, download or archive)."
        },
        "backupStartDate":{
            "type":"string",
            "description":"Date and time that the backup started."
        },
        "backupCompleteDate":{
            "type":"string",
            "description":"Date and time that the backup completed. This attribute is not valid for backups that are in progress."
        },
        "databaseIncluded":{
            "type":"boolean",
            "description":"Flag that specifies whether a database backup was performed as part of a backup operation on the Oracle Java Cloud Service instance. If <code>false</code>, a database backup was not performed. If <code>true</code>, a database backup was performed.<p>Note: This attribute is always <code>false</code> on Oracle Java Cloud Service instances that that are associated with the following database services for the required infrastructure schema:<ul><li>Oracle Autonomous Transaction Processing</li><li>Oracle Cloud Infrastructure Database (DB system)</li><li>Oracle Database Exadata Cloud Service</li></ul><p>"
        },
        "dbTag":{
            "type":"string",
            "description":"An RMAN tag or a timestamp. The attribute is included only if a database backup was performed as part of the Oracle Java Cloud Service instance backup. <p>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."
        },
        "deletedOnDate":{
            "type":"string",
            "description":"Date and time that the backup deletion completed. This attribute is not valid for backups that are in progress or still available."
        },
        "expirationDate":{
            "type":"string",
            "description":"Date and time that the backup will be deleted automatically from storage. If the value is <code>null</code>, the backup is retained indefinitely or until you manually delete it. (Value is <code>null</code> when <code>keepForever</code> was set to <code>true</code> for an on-demand backup.)"
        },
        "href":{
            "type":"string",
            "description":"URI of the backup resource."
        },
        "full":{
            "type":"boolean",
            "description":"Flag that specifies whether this is a full (<code>true</code>) or incremental (<code>false</code>) 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."
        },
        "initiatedBy":{
            "type":"string",
            "description":"User account that initiated this operation. If the operation is a scheduled automated backup, the value is <code>scheduled</code>."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID for the backup."
        },
        "local":{
            "type":"boolean",
            "description":"Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server (<code>true</code>) host, or archived and stored remotely (<code>false</code>) in the specified object storage container or bucket."
        },
        "localCopy":{
            "type":"boolean",
            "description":"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."
        },
        "notes":{
            "type":"string",
            "description":"Free-form text that provides additional information about the backup."
        },
        "requiresForceScaleFor":{
            "type":"array",
            "description":"One or more host names of nodes on the current Oracle Java Cloud Service instance that are not found in this backup.<p>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:<ul><li>Scale in the service instance before you attempt to use this backup to restore the instance.</li><li>Set <code>forceScaleIn</code> to <code>true</code> in the restore request to automatically scale in the service instance as part of the restore operation. See <a href='http://www.oracle.com/pls/topic/lookup?ctx=cloud&id=jcs_rest_restore'>Restore a Service Instance</a>.</li></ul><p>Note that <code>requiresForceScaleFor</code> replaces <code>forceScaleInRequiredForRestore</code> (which is deprecated).<p>However, <code>forceScaleInRequiredForRestore</code> is available for backups of service instances that were created using the deprecated provisioning resource path and endpoint:<p><code>/paas/service/jcs/api/v1.1/instances/{identityDomainId}</code>",
            "items":{
                "type":"string"
            }
        },
        "serviceComponents":{
            "type":"array",
            "description":"Groups service component details. Some service instances may return objects in this array.",
            "items":{
                "$ref":"#/definitions/servicecomponents"
            }
        },
        "size":{
            "type":"string",
            "description":"Size of the backup, in MBs. For example: <code>1011.4MB</code> (backup complete) or <code>Unknown</code> (backup in-progress)."
        },
        "sizeInBytes":{
            "type":"integer",
            "description":"Size of the backup, in Bytes."
        },
        "status":{
            "type":"string",
            "description":"Status of the backup. Valid values include: <code>Completed</code>, <code>Failed</code>, <code>Deleted</code>, <code>Backup In Progress</code>, <code>Upload In Progress</code>, <code>Download In Progress</code>, <code>Restore In Progress</code>, <code>Delete In Progress</code>, or <code>Retired</code>.<p>If the status is <code>Retired</code>, the reason is indicated in the <code>retiredFor</code> value. For example, the database schema password was changed (<code>schPwd</code>)."
        },
        "storageContainer":{
            "type":"string",
            "description":"Where service instance backups are stored."
        }
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"One or more host names of nodes on the current Oracle Java Cloud Service instance that are not found in this backup.<p>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:<ul><li>Scale in the service instance before you attempt to use this backup to restore the instance.</li><li>Set <code>forceScaleIn</code> to <code>true</code> in the restore request to automatically scale in the service instance as part of the restore operation. See <a href='http://www.oracle.com/pls/topic/lookup?ctx=cloud&id=jcs_rest_restore'>Restore a Service Instance</a>.</li></ul><p>Note that <code>requiresForceScaleFor</code> replaces <code>forceScaleInRequiredForRestore</code> (which is deprecated).<p>However, <code>forceScaleInRequiredForRestore</code> is available for backups of service instances that were created using the deprecated provisioning resource path and endpoint:<p><code>/paas/service/jcs/api/v1.1/instances/{identityDomainId}</code>",
    "items":{
        "type":"string"
    }
}

Nested Schema : serviceComponents

Type: array

Groups service component details. Some service instances may return objects in this array.

Show Source

• Array of: object servicecomponents
  Some service instances may return objects in the serviceComponents array.

{
    "type":"array",
    "description":"Groups service component details. Some service instances may return objects in this array.",
    "items":{
        "$ref":"#/definitions/servicecomponents"
    }
}

Nested Schema : servicecomponents

Type: object

Some service instances may return objects in the serviceComponents array.

Show Source

• type(optional): string
  Service component type. Valid values are JDK, OTD, OTD_JDK, or WLS.
• version(optional): string
  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.

{
    "description":"Some service instances may return objects in the <code>serviceComponents</code> array.",
    "properties":{
        "type":{
            "type":"string",
            "description":"Service component type. Valid values are <code>JDK</code>, <code>OTD</code>, <code>OTD_JDK</code>, or <code>WLS</code>."
        },
        "version":{
            "type":"string",
            "description":"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 all backups 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

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Tue, 07 Mar 2017 19:13:31 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 backups response body for a service instance that was created after release 17.4.1.

{
   "backups":[
      {
         "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\/jaas\/instances\/ExampleInstance\/backups\/2c56624c-1dd1-41cf-b1f6-552d29035f76",
         "notes":"Automated backup",
         "dbTag":"TAG20180914T121502"
      },
      {
         "backupId":"5ad5669b-4025-44ee-af05-5a30da8dae75",
         "jobId":"20925809",
         "backupStartDate":"2018-09-17T12:10:29.690+0000",
         "backupCompleteDate":"2018-09-17T12:17:51.184+0000",
         "expirationDate":"2018-09-17T14:10:29.690+0000",
         "initiatedBy":"scheduled",
         "full":false,
         "local":false,
         "localCopy":true,
         "databaseIncluded":true,
         "size":"14.9MB",
         "sizeInBytes":15641082,
         "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\/5ad5669b-4025-44ee-af05-5a30da8dae75",
         "notes":"Automated backup",
         "dbTag":"TAG20180917T121351"
      }
   ]
}

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

{
    "backups":[
    {
        "backupId":"1449332100032",
        "jobId":"8191",
        "backupStartDate":"Sat Dec 05 16:15:00 GMT 2016",
        "backupCompleteDate":"Sat Dec 05 17:36:18 GMT 2016",
        "expirationDate":"Mon Jan 04 16:15:00 GMT 2017",
        "initiatedBy":"scheduled",
        "full":true,
        "local":false,
        "localCopy":true,
        "databaseIncluded":true,
        "size":"15.8MB",
        "sizeInBytes":16557866,
        "dbTag":"TAG20151205T163004",
        "status":"Completed",
        "storageContainer":"Storage-ExampleIdentityDomain\/JCSBackups"
        "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/1449332100032",
        "serviceComponents":[
        {
            "type":"OTD_JDK",
            "version":"1.7.0_91"
        },
        {
            "type":"JDK",
            "version":"1.7.0_91"
        },
        {
            "type":"WLS",
            "version":"12.1.3.0.5"
        },
        {
            "type":"OTD",
            "version":"11.1.1.9.1"
        }],
        "notes":"Automated backup"
    },
    {
        "backupId":"1449340039298",
        "jobId":"8213",
        "backupStartDate":"Sat Dec 05 18:27:19 GMT 2016",
        "backupCompleteDate":"Sat Dec 05 18:29:53 GMT 2016",
        "expirationDate":"Mon Jan 04 18:27:19 GMT 2017",
        "initiatedBy":"username",
        "full":true,
        "local":false,
        "localCopy":true,
        "databaseIncluded":false,
        "size":"16MB",
        "sizeInBytes":16792928,
        "status":"Completed",
        "storageContainer":"Storage-ExampleIdentityDomain\/JCSBackups"
        "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/1449340039298",
        "serviceComponents":[
        {
            "type":"OTD_JDK",
            "version":"1.7.0_91"
        },
        {
            "type":"JDK",
            "version":"1.7.0_91"
        },
        {
            "type":"WLS",
            "version":"12.1.3.0.5"
        },
        {
            "type":"OTD",
            "version":"11.1.1.9.1"
        }]
    },
    {...}
    ],
    "backupInProgress":{
        "backupId":"1449346810790",
        "jobId":"8221",
        "backupStartDate":"Sat Dec 05 20:20:10 GMT 2016",
        "expirationDate":"Mon Jan 04 20:20:10 GMT 2017",
        "initiatedBy":"username",
        "full":true,
        "local":true,
        "localCopy":false,
        "databaseIncluded":true,
        "size":"Unknown",
        "sizeInBytes":0,
        "dbTag":"unavailable",
        "status":"Backup In Progress",
        "storageContainer":"Storage-ExampleIdentityDomain\/JCSBackups"
        "href":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backups\/144934681079
0",
        "notes":"On-demand full with database..."
    }
}

Back to Top