Jump to

• Request
• Response
• Examples

Delete a Backup

post

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

Deletes a backup of a MySQL Cloud Service instance. This is an asynchronous operation.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Name of the identity domain for the MySQL Cloud Service account.
• 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.

Body ()

The request body contains details of the delete backup request. You must specify at least one attribute.

Root Schema : backup-delete-request

Type: object

The request body defines the details of the delete backup request. You must specify at least one attribute.

Show Source

• backupId(optional): string
  ID of the backup that you want to delete.
• backupIdList(optional): array backupIdList
  List of backup IDs that you want to delete. If the list contains the ID for a full backup, all of its related (non-deleted) incremental backups must be included the list.

{
    "type":"object",
    "description":"The request body defines the details of the delete backup request. You must specify at least one attribute.",
    "properties":{
        "backupId":{
            "type":"string",
            "description":"ID of the backup that you want to delete."
        },
        "backupIdList":{
            "type":"array",
            "description":"List of backup IDs that you want to delete. If the list contains the ID for a full backup, all of its related (non-deleted) incremental backups must be included the list.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : backupIdList

Type: array

List of backup IDs that you want to delete. If the list contains the ID for a full backup, all of its related (non-deleted) incremental backups must be included the list.

Show Source

• [0]: string

{
    "type":"array",
    "description":"List of backup IDs that you want to delete. If the list contains the ID for a full backup, all of its related (non-deleted) incremental backups must be included the list.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

• application/json

202 Response

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

Body ()

Root Schema : Response Body

Type: object

Title: Response Body

The response body contains information about the operation.

Show Source

• job_id(optional): string
  Job ID for the operation.
• operationName(optional): string
  Name of the operation. For example: start-backup, restore-backup, or delete-backup.
• target_uri(optional): string
  Target URI. Poll the URI to get the target information or status of the operation.

{
    "title":"Response Body",
    "type":"object",
    "description":"The response body contains information about the operation.",
    "properties":{
        "operationName":{
            "description":"Name of the operation. For example: <code>start-backup</code>, <code>restore-backup</code>, or <code>delete-backup</code>.",
            "type":"string"
        },
        "target_uri":{
            "description":"Target URI. Poll the URI to get the target information or status of the operation.",
            "type":"string"
        },
        "job_id":{
            "description":"Job ID for the operation.",
            "type":"string"
        }
    }
}

404 Response

Not found. Returned if the backup does not exist.

Examples

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

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.

Note: The "View All Backups" operation includes the available backupId values for this operation. Our example provides this data using curl's -d (--data) option.

Note: The "View the Activity Log of a Job" operation can provide information about the returned job id, including the delete job's status.

cURL Command

curl -i -X POST \
  -u "username:password" \
  -H "X-ID-TENANT-NAME: ExampleIdentityDomain" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"backupId":"e7e0a147-133b-427e-a448-a56c679c9cbc"}' \
  https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/deletedbackups 

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 202 Accepted
Server: Oracle-Application-Server-11g
Location: https://rest_server_url:443/paas/api/v1.1/activitylog/exampleidentitydomain/job/2227335
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: lopV0F05Gu0HRsgf000000W5i^u1o6Ed3M
X-ORACLE-DMS-ECID: lopV0F05Gu0HRsgf000000W5i^u1o6Ed3M
Access-Control-Allow-Origin: *
X-Frame-Options: DENY
Content-Type: application/json
Vary: user-agent
Date: Thu, 15 Dec 2016 01:15:53 GMT
Connection: close

Example of Response Body

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

{
    "operationName": "delete-backup",
    "target_uri": "https:\/\/rest_server_url:443\/paas\/api\/v1.1\/instancemgmt\/exampleidentitydomain\/services\/MySQLCS\/instances\/MyTestInstance\/deletedbackups\/2227335",
    "job_id": "2227335"
}