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

View a Backup Configuration

get

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

Returns the backup configuration for the MySQL Cloud Service instance. The information includes:
  • Default retention time for incremental backups and full on-demand backups; full scheduled backups are retained until their last related incremental backup is no longer available
  • Schedule for full backups
  • Schedule for incremental backups
  • Date and time of the last successful backup
  • Date and time for the next scheduled backup (both full and incremental)
  • Total cloud storage container used for backups and total backup volume used

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 includes information about the backup configuration. If an update request was initiated and successfully completed, the response body shows the updated configuration.
Root Schema : backup-config-response
Type: object
The response body includes information about the backup configuration. If an update request was initiated and successfully completed, the response body shows the updated configuration.
Show Source
Nested Schema : backup-schedule
Type: object
Attributes for fullBackupSchedule and incrementalBackupSchedule.
Show Source
  • Day of the month. This value is not configurable. It defaults to all days of the month with is an astrisk (*).
  • Day of the week. Valid values are: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For full backups, only one value (day) is allowed. For incremental backups, one or more values (days) are allowed. If a value is not specified for incremental backups, the default value is calculated as all days except the day that full backups are initiated.
  • Hours. Valid values are 0 to 23.
  • Minutes. Valid values are 0 to 59.
  • Month. This value is not configurable. It defaults to all months with an astrisk (*).
  • Seconds. This value is not configurable. It defaults to 0.
  • Year. This value is not configurable. It defaults to all years (*).

Examples

The following example shows how to view a backup configuration 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

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

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

Example of Response Body

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

{
    "defaultRetention": "30 days",
    "fullBackupSchedule": {
        "second": "0",
        "minute": "0",
        "hour": "12",
        "dayOfMonth": "*",
        "month": "*",
        "dayOfWeek": "Thu",
        "year": "*"
    },
    "incrementalBackupSchedule": {
        "second": "0",
        "minute": "0",
        "hour": "12",
        "dayOfMonth": "*",
        "month": "*",
        "dayOfWeek": "Sun,Mon,Tue,Wed,Fri,Sat",
        "year": "*"
    },
    "scheduledBackups": "ALL",
    "extendedRestoreTypes": "pit",
    "nextFullBackupDate": "2016-12-15T12:00:00.000+0000",
    "nextIncrementalBackupDate": "2016-12-16T12:00:00.000+0000",
    "backupDestination": "BOTH",
    "cloudStorageContainer": "Storage-ExampleIdentityDomain\/MyBackupContainer",
    "cloudStorageUser": "username",
    "totalCloudStorageContainerUsed": "0.0MB",
    "totalCloudStorageContainerUsedInBytes": 0,
    "totalBackupVolumeUsed": "0.0MB",
    "totalBackupVolumeUsedInBytes": 0,
    "percentBackupVolumeUsed": 0
}