Jump to

• Request
• Response
• Examples

View a Deleted Backup

get

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

Returns information about a deleted backup for an Oracle Java Cloud Service instance based on the job ID provided.

For complete information about contents of backups, where backups are stored, and how backups and local copies of backups are deleted automatically, 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.
• jobId: string
  Job ID for the backup deletion. To retrieve the backup deletion job ID, see View All Deleted Backups. This can also be the job ID for the backup deletion (asynchronous) as described in Delete a Backup (Asynchronous).
• serviceId: string
  Name of the Oracle Java Cloud Service instance.

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

200 Response

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

Body ()

Root Schema : viewdeleted-response

Type: object

The response body contains information about a backup deleted synchronously or asynchronously, or a list of backups deleted asynchronously.

Show Source

• delete-backup(optional): array delete-backup
  Groups information about a deleted backup.
• delete-backups(optional): array delete-backups
  Groups information about a list of backups deleted asynchronously.

{
    "description":"The response body contains information about a backup deleted synchronously or asynchronously, or a list of backups deleted asynchronously.",
    "properties":{
        "delete-backup":{
            "type":"array",
            "description":"Groups information about a deleted backup.",
            "items":{
                "$ref":"#/definitions/delete-backup"
            }
        },
        "delete-backups":{
            "type":"array",
            "description":"Groups information about a list of backups deleted asynchronously.",
            "items":{
                "$ref":"#/definitions/delete-backup"
            }
        }
    }
}

Nested Schema : delete-backup

Type: array

Groups information about a deleted backup.

Show Source

• Array of: object delete-backup

{
    "type":"array",
    "description":"Groups information about a deleted backup.",
    "items":{
        "$ref":"#/definitions/delete-backup"
    }
}

Nested Schema : delete-backups

Type: array

Groups information about a list of backups deleted asynchronously.

Show Source

• Array of: object delete-backup

{
    "type":"array",
    "description":"Groups information about a list of backups deleted asynchronously.",
    "items":{
        "$ref":"#/definitions/delete-backup"
    }
}

Nested Schema : delete-backup

Type: object

Show Source

• completeDate(optional): string
  Date and time the delete backup operation completed.
• jobId(optional): string
  Job ID for the delete backup operation.
• operation(optional): string
  Type of operation that was executed. Set to delete.
• startDate(optional): string
  Date and time the delete backup operation started.
• status(optional): string
  Status of the delete backup operation. Valid values include: Completed, Failed, Deleted, Delete In Progress, or Retired.
• statusDetails(optional): string
  History of system messages. Each message is separated by an ellipses {...}.

{
    "properties":{
        "completeDate":{
            "type":"string",
            "description":"Date and time the delete backup operation completed."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID for the delete backup operation."
        },
        "operation":{
            "type":"string",
            "description":"Type of operation that was executed. Set to <code>delete</code>."
        },
        "startDate":{
            "type":"string",
            "description":"Date and time the delete backup operation started."
        },
        "status":{
            "type":"string",
            "description":"Status of the delete backup operation. Valid values include: <code>Completed</code>, <code>Failed</code>, <code>Deleted</code>, <code>Delete In Progress</code>, or <code>Retired</code>."
        },
        "statusDetails":{
            "type":"string",
            "description":"History of system messages. Each message is separated by an ellipses <code>{...}</code>."
        }
    }
}

400 Response

Bad Request. Returned if the job ID does not exist.

Back to Top

Examples

The following example shows how to view information about a deleted backup 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 "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/deletedbackups/4779

Example of Response Header

The following shows an example of the response header:

HTTP/1.1 200 OK
Date: Wed, 23 Mar 2016 20:01:38 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows a response returned in JSON format, for a single backup that was deleted asynchronously.

{
    "delete-backup":[
    {
        "operation":"delete",
        "jobId":"8376",
        "status":"Completed",
        "startDate":"Tue Dec 08 18:19:53 GMT 2015",
        "completeDate":"Tue Dec 08 18:20:25 GMT 2015",
        "statusDetails":"Deleting the backup archive in the Oracle Storage Cloud Service container...
           Deleted the backup archive in the Oracle Storage Cloud Service container...
           Deleted the local backup..."
    }]
}

The following example shows a response returned in JSON format, for a list of backups deleted asynchronously.

{
    "delete-backups":[
    {
        "operation":"delete",
        "jobId":"4211",
        "status":"In Progress",
        "startDate":"Fri Mar 18 14:57:53 GMT 2016"
    },
    {
        "operation":"delete",
        "jobId":"4208",
        "status":"Completed",
        "startDate":"Fri Mar 18 14:57:21 GMT 2016",
        "completeDate":"Fri Mar 18 14:57:53 GMT 2016",
        "statusDetails":"Deleting the backup archive from the Oracle Storage Cloud Service container...
           Deleted the backup archive in the Oracle Storage Cloud Service container...
           Deleted the local copy of the backup with the ID 1458254176358..."
    }]
}

The following example shows a response returned in JSON format, for a backup that was deleted synchronously.

{
    "delete-backup":[
    {
        "operation":"delete",
        "jobId":"4779",
        "status":"Completed",
        "startDate":"Wed Mar 23 19:58:21 GMT 2016",
        "completeDate":"Wed Mar 23 19:58:54 GMT 2016",
        "statusDetails":"Deleting the backup archive from the Oracle Storage Cloud Service container...
           Deleted the backup archive in the Oracle Storage Cloud Service container...
           Deleted the local copy of the backup with the ID 1458365400062..."
    }]
}

Back to Top