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 a Database Classic Cloud Service instance, including both scheduled and on-demand backups.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

• serviceId: string
  Name of the Database Classic Cloud Service instance.

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
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

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 this 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 this backup is a long term backup."
        }
    }
}

Back to Top

Examples

The following example shows how to view a list of all available backup operations for a Database Classic Cloud Service instance by submitting a GET request on the REST endpoint using cURL.

This example uses a traditional cloud account, so the {identityDomainId} path parameter and the X-ID-TENANT-NAME header parameter are set to the account's domain name, which is usexample. The service instance is db12c-xp-si and the Oracle Cloud user name of the user making the call is dbcsadmin.

cURL Command

$ curl --include --request GET \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c-xp-si/backups

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Content-Length: 716
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
X-Frame-Options: DENY
Vary: Accept-Encoding,User-Agent
Content-Language: en
Content-Type: application/json

Response Body

{
  "backupList":[
    {
      "backupCompleteDate":"28-Jun-2016 02:26:27 UTC",
      "dbTag":"TAG20160628T022627",
      "status":"COMPLETED"
    },
    {
      "backupCompleteDate":"27-Jun-2016 02:27:36 UTC",
      "dbTag":"TAG20160627T022736",
      "status":"COMPLETED"
    },
    {
      "backupCompleteDate":"26-Jun-2016 02:27:24 UTC",
      "dbTag":"TAG20160626T022724",
      "status":"COMPLETED"
    },
    {
      "backupCompleteDate":"25-Jun-2016 02:27:01 UTC",
      "dbTag":"TAG20160625T022701",
      "status":"COMPLETED"
    },
    {
      "backupCompleteDate":"24-Jun-2016 02:26:05 UTC",
      "dbTag":"TAG20160624T022605",
      "status":"COMPLETED"
    },
    {
      "backupCompleteDate":"23-Jun-2016 02:27:34 UTC",
      "dbTag":"TAG20160623T022734",
      "status":"COMPLETED"
    },
    {
      "backupCompleteDate":"22-Jun-2016 02:29:20 UTC",
      "dbTag":"TAG20160622T022920",
      "status":"COMPLETED"
    }
  ]
}

Back to Top