Jump to

• Request
• Response
• Examples

View a Deleted Backup

get

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

Returns information about a deleted backup for a MySQL Cloud Service instance, based on the job ID of the operation that deleted the backup.

Request

Path Parameters

• identityDomainId: string
  Name of the identity domain for the MySQL Cloud Service account.
• jobId: string
  Job ID of the operation that deleted the backup.
• serviceId: string
  The user-defined name of the Oracle MySQL Cloud Service instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Name of the identity domain for the MySQL Cloud Service account.

Response

200 Response

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

Body ()

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

Root Schema : backup-view-deleted-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.

{
    "type":"object",
    "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/backup-delete-info"
            }
        },
        "delete-backups":{
            "type":"array",
            "description":"Groups information about a list of backups deleted asynchronously.",
            "items":{
                "$ref":"#/definitions/backup-delete-info"
            }
        }
    }
}

Nested Schema : delete-backup

Type: array

Groups information about a deleted backup.

Show Source

• [0]: object backup-delete-info

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

Nested Schema : delete-backups

Type: array

Groups information about a list of backups deleted asynchronously.

Show Source

• [0]: object backup-delete-info

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

Nested Schema : backup-delete-info

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, or Delete In Progress.
• statusDetails(optional): string
  History of system messages. Each message is separated by an ellipses {...}.

{
    "type":"object",
    "properties":{
        "operation":{
            "type":"string",
            "description":"Type of operation that was executed. Set to <code>delete</code>."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID for the delete backup operation."
        },
        "status":{
            "type":"string",
            "description":"Status of the delete backup operation. Valid values include: <code>Completed</code>, <code>Failed</code>, <code>Deleted</code>, or <code>Delete In Progress</code>."
        },
        "startDate":{
            "type":"string",
            "description":"Date and time the delete backup operation started."
        },
        "completeDate":{
            "type":"string",
            "description":"Date and time the delete backup operation completed."
        },
        "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.

Examples

The following example shows how to see the progress of a delete backup operation for a MySQL Cloud Service instance by submitting a GET request on the REST endpoint using cURL.

In this example, information is retrieved for a job id that deleted a backup of the MySQL Cloud Service instance named MyTestInstance in the identity domain ExampleIdentityDomain where the job id for the delete backup operation is 2227335.

Note: Deleting a backup uses a backup id, and it then returns a job id in the response body for that delete operation. This is the job id that you use here to retrieve the status of that delete operation.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the Oracle Public Cloud or Oracle Cloud Machine REST server to contact for your identity domain or tenant name. See Send Requests for the appropriate URL structure to use on Oracle Public Cloud or Oracle Cloud Machine.

cURL Command

curl -i -X GET \
  -u "username:password" \
  -H "X-ID-TENANT-NAME: ExampleIdentityDomain" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/deletedbackups/2227335

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: Oracle-Application-Server-11g
Content-Language: en
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: 0KI7u0z0uF0p0dSeB66Hp0Ri62Y05H0fG0
X-ORACLE-DMS-ECID: 0KI7u0z0uF0p0dSeB66Hp0Ri62Y05H0fG0
Access-Control-Allow-Origin: *
X-Frame-Options: DENY
Content-Type: application/json
Vary: user-agent
Date: Thu, 15 Dec 2016 01:39:42 GMT
Content-Length: 216
Connection: keep-alive

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "delete-backup": [
        {
            "operation": "delete",
            "jobId": "2227335",
            "status": "Completed",
            "startDate": "2016-12-15T01:15:53.435+0000",
            "completeDate": "2016-12-15T01:15:57.844+0000",
            "statusDetails": "Deleted the backup archive."
        }
    ]
}