View All Backup Operations
/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups
Request
-
identityDomainId: string
The value depends on the type of Exadata Cloud at Customer account that is used to make the request:
For a Traditional Cloud Account, specify the
Identity Domain Name
that is associated with the service.For a Cloud Account with Identity Cloud Service, specify the
Identity Service Id
that is associated with the service, which is a character string beginning withidcs-
.
-
serviceId: string
Name of the Exadata Cloud at Customer database deployment.
-
Authorization: string
Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
-
X-ID-TENANT-NAME: string
The value depends on the type of Exadata Cloud at Customer account that is used to make the request:
For a Traditional Cloud Account, specify the
Identity Domain Name
that is associated with the service.For a Cloud Account with Identity Cloud Service, specify the
Identity Service Id
that is associated with the service, which is a character string beginning withidcs-
.
For more information, see Security, Authentication and Authorization.
Response
- application/json
200 Response
object
Response Body
-
backupList(optional):
array backupList Array
Title:
backupList Array
Array of JSON object elements, with one element for each backup operation.
array
backupList Array
-
Array of:
object backupList Array Item
Title:
backupList Array Item
object
backupList Array Item
-
backupCompletedDate(optional):
string
The date-and-time stamp when the backup operation completed. Applies to completed backups only.
-
backupStartDate(optional):
string
The date-and-time stamp when the backup operation started. Applies to in-progress and failed backups only.
-
dbTag(optional):
string
Tag that uniquely identifies the backup. Applies to completed backups only.
-
keepForever(optional):
boolean
Boolean indicating if the backup is a long term backup.
-
status(optional):
string
Status of the backup; one of
IN PROGRESS
,FAILED
, orCOMPLETED
. Note that there is only one in-progress backup at any given time, and that only the last failed backup is listed.
Examples
The following example shows how to view information about backups associated with an Exadata Cloud at Customer database deployment by submitting a GET request on the REST endpoint using cURL.
In this example, the identity domain is usexample
, the Exadata Cloud at Customer database deployment is db12c
and the Oracle Cloud user name and password are serviceadmin
and Pa55_word
.
cURL Command
curl -i -X GET --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample" https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c/backups
HTTP Status Code and Response Headers
HTTP/2.0 200 server: Oracle-Application-Server-11g strict-transport-security: max-age=31536000;includeSubDomains content-language: en access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD x-oracle-dms-ecid: 005KB8HH5hV6uHFpR05Eid0007dd0002o_ x-oracle-dms-ecid: 005KB8HH5hV6uHFpR05Eid0007dd0002o_ access-control-allow-origin: * x-frame-options: DENY content-type: application/json vary: user-agent date: Mon, 29 May 2017 23:30:12 GMT content-length: 136
Response Body
{ "backupList": [{ "backupCompleteDate": "29-May-2017 23:27:51 UTC", "dbTag": "TAG20170529T232751", "status": "COMPLETED", "keepForever": false } ] }