1. REST API for MySQL Cloud Service
  2. Tasks
  3. Backups

View All Backup Operations

get

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

Returns a list of backup operations performed on a MySQL Cloud Service instance.

Request

Path Parameters
Header Parameters

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
The response body contains information about all backups.
Root Schema : backup-view-all-response
Type: object
The response body contains information about all backups.
Show Source
Nested Schema : backupInProgress
Type: array
Groups the backups currently in progress, if any.
Show Source
Nested Schema : backups
Type: array
Groups all completed backups.
Show Source
Nested Schema : lastFailedBackup
Type: array
Groups the failed backups, if any.
Show Source
Nested Schema : backup-view-response
Type: object
Show Source
Nested Schema : incrementalBackups
Type: array
List of incremental backups linked to the full backup, if any.
Show Source
Nested Schema : jobHistory
Type: array
Groups job history details. The job history details only return for a specific backup request.
Show Source
Nested Schema : backup-view-info
Type: object
Show Source
Nested Schema : backup-job-history
Type: object
Show Source

Examples

The following example shows how to view a list of all backups for a MySQL Cloud Service instance by submitting a GET 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.

cURL Command

This example retrieves executed backup operations for a MySQL Cloud Service instance named MyTestInstance in the ExampleIdentityDomain identity domain. 

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/backups

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: E05G0RW0gpG0JqduifH6FVu0i0008103p5
X-ORACLE-DMS-ECID: E05G0RW0gpG0JqduifH6FVu0i0008103p5
Access-Control-Allow-Origin: *
X-Frame-Options: DENY
Content-Type: application/json
Vary: user-agent
Date: Thu, 15 Dec 2016 01:06:38 GMT
Content-Length: 1725
Connection: keep-alive

Example of Response Body

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

{
    "backups": [
        {
            "backupId": "e7e0a147-133b-427e-a448-a56c679c9cbc",
            "jobId": "4226416",
            "backupStartDate": "2016-12-15T00:46:18.243+0000",
            "backupCompleteDate": "2016-12-15T00:46:46.249+0000",
            "expirationDate": "2017-01-14T00:46:18.243+0000",
            "initiatedBy": "username",
            "full": true,
            "local": false,
            "localCopy": true,
            "databaseIncluded": false,
            "size": "2.7MB",
            "sizeInBytes": 2881001,
            "status": "Completed",
            "storageContainer": "Storage-exampleidentitydomain\/MyBackupContainer",
            "href": "https:\/\/rest_server_url:443\/paas\/api\/v1.1\/instancemgmt\/exampleidentitydomain\/services\/MySQLCS\/instances\/MyTestInstance\/backups\/e7e0a147-133b-427e-a448-a56c679c9cbc",
            "tag": "{\"startTime\":1481762779,\"endTime\":1481762780,\"startLSN\":1731072,\"endLSN\":1731376,\"lastBinLog\":\"mytestinstance-mysql-1.000002\",\"lastBinLogPos\":3652,\"triggeredBy\":\"username\"}"
        },
        {
            "backupId": "104148c3-2140-484b-8012-efc1c4907c74",
            "jobId": "4223717",
            "backupStartDate": "2016-12-15T00:51:44.924+0000",
            "backupCompleteDate": "2016-12-15T00:51:50.029+0000",
            "expirationDate": "2017-01-14T00:51:44.924+0000",
            "initiatedBy": "username",
            "full": true,
            "local": false,
            "localCopy": true,
            "databaseIncluded": false,
            "size": "2.8MB",
            "sizeInBytes": 2955038,
            "status": "Completed",
            "storageContainer": "Storage-exampleidentitydomain\/MyBackupContainer",
            "href": "https:\/\/rest_server_url:443\/paas\/api\/v1.1\/instancemgmt\/exampleidentitydomain\/services\/MySQLCS\/instances\/MyTestInstance\/backups\/104148c3-2140-484b-8012-efc1c4907c74",
            "tag": "{\"startTime\":1481763105,\"endTime\":1481763106,\"startLSN\":1731072,\"endLSN\":1731376,\"lastBinLog\":\"mytestinstance-mysql-1.000002\",\"lastBinLogPos\":3652,\"triggeredBy\":\"username\"}"
        }
    ]
}