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

View a Backup

get

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

Returns information about a performed backup operation on a MySQL Cloud Service instance.

Request

Path Parameters
Query Parameters
  • Flag that specifies whether to include information (true) or exclude information about related backups (false). When set to true:
    • For a full backup, includes information about all incremental backups performed since the last full backup.
    • For an incremental backup, includes information about the previous full backup.
    Defaults to false, excluding information about related backups.
Header Parameters

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
Root 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 retrieves information about a specific backup id 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 information for backup id 104148c3-2140-484b-8012-efc1c4907c74 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/104148c3-2140-484b-8012-efc1c4907c74

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

Example of Response Body

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

{
	"backupId": "104148c3-2140-484b-8012-efc1c4907c74",
	"jobId": "8223717",
	"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",
	"jobHistory": [
		{
			"operation": "backup",
			"jobId": "4223717",
			"status": "Completed",
			"startDate": "2016-12-15T00:51:44.924+0000",
			"completeDate": "2016-12-15T00:51:50.029+0000",
			"statusDetails": "Backup and backup image validation completed successfully."
		}
	],
	"tag": "{\"startTime\":1481763105,\"endTime\":1481763106,\"startLSN\":1731072,\"endLSN\":1731376,\"lastBinLog\":\"mytestinstance-mysql-1.000002\",\"lastBinLogPos\":3652,\"triggeredBy\":\"username\"}"
}