Jump to

• Request
• Response
• Examples

View All Restore Operations

get

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

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

By default, only successful restoration operations are included. Set the includeFailed query parameter to true to include both successful and failed restoration operations.

Request

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.

Response

Supported Media Types

• application/json

200 Response

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

Body ()

The response body contains the details of the restoration operations.

Root Schema : backup-view-all-restorations-response

Type: object

The response body contains the details of the restoration operations.

Show Source

• restoreHistory(optional): array restoreHistory
  Groups all completed restoration operations.
• restoreInProgress(optional): array restoreInProgress
  Groups details of a restoration operation currently in progress, if any.

{
    "type":"object",
    "description":"The response body contains the details of the restoration operations.",
    "properties":{
        "restoreHistory":{
            "type":"array",
            "description":"Groups all completed restoration operations.",
            "items":{
                "$ref":"#/definitions/backup-restore-history"
            }
        },
        "restoreInProgress":{
            "type":"array",
            "description":"Groups details of a restoration operation currently in progress, if any.",
            "items":{
                "$ref":"#/definitions/backup-restore-history"
            }
        }
    }
}

Nested Schema : restoreHistory

Type: array

Groups all completed restoration operations.

Show Source

• [0]: object backup-restore-history

{
    "type":"array",
    "description":"Groups all completed restoration operations.",
    "items":{
        "$ref":"#/definitions/backup-restore-history"
    }
}

Nested Schema : restoreInProgress

Type: array

Groups details of a restoration operation currently in progress, if any.

Show Source

• [0]: object backup-restore-history

{
    "type":"array",
    "description":"Groups details of a restoration operation currently in progress, if any.",
    "items":{
        "$ref":"#/definitions/backup-restore-history"
    }
}

Nested Schema : backup-restore-history

Type: object

Show Source

• backupDate(optional): string
  Date and time of the backup.
• backupId(optional): string
  Backup ID.
• jobId(optional): string
  Job ID for the restore operation.
• notes(optional): string
  Free-form text that provides additional information about the restoration operation.
• recoveryCompleteDate(optional): string
  Date and time that the restoration operation completed. This information is not displayed for restorations that are still in progress.
• recoveryStartDate(optional): string
  Date and time that the restoration operation started.
• restoreId(optional): string
  Defined for Point-In-Time (PIT) restorations, its timestamp is displayed as MM/DD/YYYY HH:MM:SS. For example, 03/12/2016 17:20:55.
• restoreType(optional): string
  Defined for Point-In-Time (PIT) restorations, the only supported value is pit (Point-In-Time).
• status(optional): string
  Status of the operation. Valid values include: Completed, Failed, or Restore In Progress.
• statusDetails(optional): string
  History of system messages.

{
    "type":"object",
    "properties":{
        "backupId":{
            "type":"string",
            "description":"Backup ID."
        },
        "backupDate":{
            "type":"string",
            "description":"Date and time of the backup."
        },
        "restoreType":{
            "type":"string",
            "description":"Defined for Point-In-Time (PIT) restorations, the only supported value is <code>pit</code> (Point-In-Time)."
        },
        "restoreId":{
            "type":"string",
            "description":"Defined for Point-In-Time (PIT) restorations, its timestamp is displayed as <code>MM/DD/YYYY HH:MM:SS</code>. For example, <code>03/12/2016 17:20:55</code>."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID for the restore operation."
        },
        "recoveryStartDate":{
            "type":"string",
            "description":"Date and time that the restoration operation started."
        },
        "recoveryCompleteDate":{
            "type":"string",
            "description":"Date and time that the restoration operation completed. This information is not displayed for restorations that are still in progress."
        },
        "status":{
            "type":"string",
            "description":"Status of the operation. Valid values include: <code>Completed</code>, <code>Failed</code>, or <code>Restore In Progress</code>."
        },
        "statusDetails":{
            "type":"string",
            "description":"History of system messages."
        },
        "notes":{
            "type":"string",
            "description":"Free-form text that provides additional information about the restoration operation."
        }
    }
}

Examples

The following example shows how to view a list of all restored backups performed on 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/restoredbackups 

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

Example of Response Body

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

{
    "restoreHistory": [
        {
            "backupId": "104148c3-2140-484b-8012-efc1c4907c74",
            "backupDate": "2016-12-15T00:51:44.924+0000",
            "jobId": "2223824",
            "recoveryStartDate": "2016-12-15T01:43:46.119+0000",
            "recoveryCompleteDate": "2016-12-15T01:45:09.927+0000",
            "status": "Completed",
            "statusDetails": "Submitted the restoration precheck for remote execution...Restore health check passed....Submitted the restoration for remote execution...Restore from backup succeeded. ...Completed the restoration",
            "notes": "Restoring backup as discussed on KB-14412"
        }
    ]
}