View the Backup Configuration
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backupconfig
- 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 About Backup and Restoration in Administering Oracle Java Cloud Service.
Request
-
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
serviceId: string
Name of the Oracle Java Cloud Service instance.
-
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.
Response
- application/json
200 Response
object
-
backupDestination(optional):
string
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 incloudStorageContainer
. -
cloudStorageContainer(optional):
string
URI of the object storage container or bucket where service instance backups are stored.
-
cloudStorageUser(optional):
string
User name for the object storage user.
-
defaultRetention(optional):
string
Number of days incremental backups and full on-demand backups are retained.
Full scheduled backups are retained until their last related incremental backup is no longer available, if any.
-
disabledOn(optional):
string
Timestamp when backups were disabled automatically due to repeated failure. If backups were disabled by the user, then the response won't include this field.
-
disabledOnError(optional):
string
The code for the error that caused the backups to be disabled automatically. The error code includes a short name and an ID, or just a short name. Here are a few examples:
ERROR_ACCESS_DENIED
208,JCS-BR-ERROR_VERIFY_REMOTE_STORAGE_ROOT
-
disabledScheduledCoordinatedBackups(optional):
boolean
Flag that specifies whether a scheduled Oracle Java Cloud Service instance backup is to include a backup of the associated database deployment.
A value of
true
means a coordinated database deployment backup is disabled (not performed) during a scheduled backup of this Oracle Java Cloud Service instance. A value offalse
means a backup of the associated database deployment is coordinated and enabled. -
extendedRestoreTypes(optional):
string
Only value is
NONE
. This means that restoration of backups is supported only by using a backup ID. -
fullBackupSchedule(optional):
array fullBackupSchedule
Schedule for the next full backup.
-
incrementalBackupSchedule(optional):
array incrementalBackupSchedule
Schedule for the next incremental backup.
-
lastBackupDate(optional):
string
Date and time that the last backup completed.
Note: If there have been no backups, this attribute is omitted.
-
lastSuccessfulCleanupDate(optional):
string
Date and time that the last successful cleanup job completed. The cleanup job is run after the scheduled backup for the day is completed. The cleanup job purges old records, deletes expired backups or removes expired local copies (that are due to be deleted or removed that day).
-
localRetention(optional):
string
Number of days to retain the copies of backups on a dedicated storage volume. Default is 7 days.
Copies of full scheduled backups are retained until the local copy of their last related incremental backup is no longer available, if any.
-
nextFullBackupDate(optional):
string
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.
-
nextIncrementalBackupDate(optional):
string
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.
-
percentBackupVolumeUsed(optional):
string
Total percent of the backup volume that is currently in use.
-
scheduledBackups(optional):
string
Type of scheduled backups.
ALL
: Both full and incremental scheduled backups are enabled.DISABLED
: Backups are disabled. SeedisabledOnError
for the reason.
-
state(optional):
string
State of the backup service for the service instance. For example,
ENABLED
orDISABLED
. -
totalBackupVolumeUsed(optional):
string
Total amount (in GBs) of the backup volume that is currently in use.
-
totalBackupVolumeUsedInBytes(optional):
string
Total amount (in Bytes) of the backup volume that is currently in use.
-
totalCloudStorageContainerUsed(optional):
string
The total amount (in GBs) of the object storage container or bucket space that is currently in use.
-
totalCloudStorageContainerUsedInBytes(optional):
string
The total amount (in Bytes) of the object storage container or bucket space that is currently in use.
array
-
Array of:
object backupschedule
Attributes for
fullBackupSchedule
andincrementalBackupSchedule
.
array
-
Array of:
object backupschedule
Attributes for
fullBackupSchedule
andincrementalBackupSchedule
.
object
fullBackupSchedule
and incrementalBackupSchedule
.-
dayOfMonth(optional):
string
Day of the month. This value is not configurable. It defaults to all days of the month (*).
-
dayOfWeek(optional):
string
Day of the week. Valid values are: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For full backups, only one value (day) is allowed. For incremental backups, one or more values (days) are allowed. If a value is not specified for incremental backups, the default value is calculated as all days except the day that full backups are initiated.
-
hour(optional):
string
Hours. Valid values are 0 to 23.
-
minute(optional):
string
Minutes. Valid values are 0 to 59.
-
month(optional):
string
Month. This value is not configurable. It defaults to all months (*).
-
second(optional):
string
Seconds. This value is not configurable. It defaults to 0.
-
year(optional):
string
Year. This value is not configurable. It defaults to all years (*).
404 Response
backupDestination
set to NONE
).Examples
The following example shows how to view the backup configuration 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/backupconfig
Example of Response Header
The following shows an example of the response header:
HTTP/1.1 200 OK
Date: Mon, 20 Jun 2016 16:55:34 GMT
Transfer-Encoding: chunked
Content-Type: application/json
If the service instance was provisioned with backupDestination
set to NONE
, the response header would show the following:
HTTP/1.1 404 Not Found
Date: Sat, 22 Apr 2017 19:32:47 GMT
Content-Type: application/json
Example of Response Body
The following shows an example of 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",
"lastBackupDate":"Mon Jun 20 14:20:00 GMT 2016",
"lastSuccessfulCleanupDate":"Mon Jun 20 14:37:29 GMT 2016",
"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,
"percentBackupVolumeUsed":0.022590864449739456
}
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",
"lastBackupDate":"Mon Jun 20 14:20:00 GMT 2016",
"lastSuccessfulCleanupDate":"Mon Jun 20 14:37:29 GMT 2016",
"backupDestination":"BOTH",
"cloudStorageContainer":"Storage-ExampleIdentityDomain\/mybackupcontainer",
"cloudStorageUser":"username",
"totalCloudStorageContainerUsed":"46.3MB",
"totalCloudStorageContainerUsedInBytes":48513508,
"totalBackupVolumeUsed":"46.3MB",
"totalBackupVolumeUsedInBytes":48513508,
"percentBackupVolumeUsed":0.022590864449739456
}