Jump to

• Request
• Response
• Examples

View All Backup Operations

get

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups

Returns a list of all available backups for an Exadata Cloud Service database deployment, including both scheduled and on-demand backups.

Request

Path Parameters

• identityDomainId: string

  The value depends on the type of Exadata Cloud Service 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 has the format idcs-letters-and-numbers.

• serviceId: string
  Name of the Exadata Cloud Service database deployment.

Header Parameters

• 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 Service 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 has the format idcs-letters-and-numbers.

  For more information, see Security, Authentication and Authorization.

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 : Response Body

Type: object

Title: Response Body

Show Source

• backupList(optional): array backupList Array
  Title: backupList Array

  Array of JSON object elements, with one element for each backup operation.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "backupList":{
            "title":"backupList Array",
            "type":"array",
            "description":"Array of JSON object elements, with one element for each backup operation.",
            "items":{
                "$ref":"#/definitions/view-all-backups-backupList-array-item"
            }
        }
    }
}

Nested Schema : backupList Array

Type: array

Title: backupList Array

Array of JSON object elements, with one element for each backup operation.

Show Source

• Array of: object backupList Array Item
  Title: backupList Array Item

{
    "title":"backupList Array",
    "type":"array",
    "description":"Array of JSON object elements, with one element for each backup operation.",
    "items":{
        "$ref":"#/definitions/view-all-backups-backupList-array-item"
    }
}

Nested Schema : backupList Array Item

Type: object

Title: backupList Array Item

Show Source

• 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, or COMPLETED. Note that there is only one in-progress backup at any given time, and that only the last failed backup is listed.

{
    "title":"backupList Array Item",
    "type":"object",
    "properties":{
        "backupCompletedDate":{
            "type":"string",
            "description":"The date-and-time stamp when the backup operation completed. Applies to completed backups only."
        },
        "backupStartDate":{
            "type":"string",
            "description":"The date-and-time stamp when the backup operation started. Applies to in-progress and failed backups only."
        },
        "dbTag":{
            "type":"string",
            "description":"Tag that uniquely identifies the backup. Applies to completed backups only."
        },
        "status":{
            "type":"string",
            "description":"Status of the backup; one of <code>IN PROGRESS</code>, <code>FAILED</code>, or <code>COMPLETED</code>. Note that there is only one in-progress backup at any given time, and that only the last failed backup is listed."
        },
        "keepForever":{
            "type":"boolean",
            "description":"Boolean indicating if the backup is a long term backup."
        }
    }
}

Back to Top

Examples

The following example shows how to view information about backups associated with an Exadata Cloud Service database deployment by submitting a GET request on the REST endpoint using cURL.

In this example, the identity domain is usexample, the Exadata Cloud Service 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
		}
	]
}

Back to Top