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

View All Applied Patches

get

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

Returns a list of all applied patches for 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 includes details of all applied patches.
Root Schema : patch-applied-all-response
Type: array
The response body includes details of all applied patches.
Show Source
Nested Schema : patch-applied-response
Type: object
Information about an applied patch.
Show Source
Nested Schema : componentPatches
Type: array
Group the details of each patches in the component.
Show Source
Nested Schema : patchComponents
Type: array
Group the details of the patch to be applied.
Show Source
Nested Schema : patch-result-info
Type: object
Groups information about the results of the patch.
Show Source
Nested Schema : progressMessages
Type: array
List of progress messages for the patch.
Show Source
Nested Schema : patch-rollback-result
Type: object
Groups information about the results of the rollback operation. This attribute displays only when a rollback of the patch had been performed.
Show Source
Nested Schema : patch-component-details-info
Type: object
Group the details of each patch in the component.
Show Source
Nested Schema : preserveFiles
Type: array
List of files to be preserved during patching.
Show Source
Nested Schema : zipBundles
Type: array
Zips that contain the patched binaries or patches.
Show Source
Nested Schema : patch-zip-bundle-info
Type: object
Group the details of zips for the patched binaries.
Show Source
Nested Schema : patch-component-applied-info
Type: object
Group the details of the patch to be applied.
Show Source
Nested Schema : preserveFiles
Type: array
List of files to be preserved during patching.
Show Source
Nested Schema : progressMessages
Type: array
List of progress messages for the patch.
Show Source
Nested Schema : progressMessages
Type: array
List of progress messages for the rollback.
Show Source

Examples

The following example shows how to view a list of applied and rolled back patches 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" \
   https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/patches/applied

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: 001GtD1d9en6uHFpR0H7id0006BS0002nl
X-ORACLE-DMS-ECID: 001GtD1d9en6uHFpR0H7id0006BS0002nl
Access-Control-Allow-Origin: *
X-Frame-Options: DENY
Content-Type: application/json
Vary: user-agent
Date: Wed, 14 Dec 2016 00:17:04 GMT
Content-Length: 2771
Connection: keep-alive

Example of Response Body

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

[
  {
    "backupStatus": "Available",
    "additionalNote": "Applying 5.7.16-EE patch as discussed with team on KB-43123.",
    "appliedBy": "someone@example.org",
    "appliedDate": "2016-12-13T21:13:16.038+0000",
    "totalTime": "1 min, 47 sec",
    "patchId": "5.7.16-EE",
    "patchDescription": "MySQL Server version 5.7.16",
    "patchReleaseUrl": "https:\/\/dev.mysql.com\/doc\/relnotes\/mysql\/5.7\/en\/news-5-7-16.html",
    "releaseDate": "2016-10-12T09:00:00.000+0000",
    "resultMessage": "MySQL patching succeeded",
    "lastStatus": "COMPLETED",
    "lastStatusMessage": "MySQL patching succeeded",
    "componentPatches": {
      "mysql": {
        "id": 1451,
        "version": "5.7",
        "releaseVersion": "5.7.16",
        "displayName": "MySQL Server version 5.7.16",
        "description": "MySQL Server version 5.7.16",
        "zipBundles": {
          "MSAAS": {
            "id": 1521,
            "md5sum": "ec434747c1e3d5d0f644ff3d9bd54915",
            "provisioningObjectRef": "MSCS\/5.7.16\/MySQL_Binaries-5.7.16.zip",
            "storageKey": "MSCS\/5.7.16\/MySQL_Binaries-5.7.16.zip",
            "releaseDate": "10\/12\/2016",
            "releaseUrl": "https:\/\/dev.mysql.com\/doc\/relnotes\/mysql\/5.7\/en\/news-5-7-16.html",
            "displayName": "MySQL Server version 5.7.16"
          }
        },
        "preserveFiles": [
          
        ]
      }
    },
    "patchComponents": [
      {
        "id": 1451,
        "component": "mysql",
        "version": "5.7",
        "md5sum": "ec434747c1e3d5d0f644ff3d9bd54915",
        "provisioningObjectRef": "MSCS\/5.7.16\/MySQL_Binaries-5.7.16.zip",
        "patchingObjectRef": "MSCS\/5.7.16\/MySQL_Binaries-5.7.16.zip",
        "preserveFiles": [
          
        ]
      }
    ],
    "patchType": "Quarterly",
    "patchCategory": "Upgrade",
    "patchSeverity": "Normal",
    "jobId": "4207169",
    "displayName": "5.7.16",
    "toVersion": "5.7.16",
    "inProgress": false,
    "operationType": "None",
    "id": 234688,
    "patchingResult": {
      "patchingId": 195821,
      "versionBeforeThisPatch": "mysql 5.7.15",
      "strategy": "Rolling",
      "releaseVersionBeforeThisPatch": "5.7.15",
      "customRollbackId": "4207169_1481663596038",
      "startDate": "2016-12-13T21:13:16.038+0000",
      "endDate": "2016-12-13T21:15:04.030+0000",
      "patchingStatus": "COMPLETED",
      "resultMessage": "MySQL patching succeeded",
      "additionalNote": "Applying 5.7.16-EE patch as discussed with team on KB-43123.",
      "appliedBy": "someone@example.org",
      "jobId": "4207169",
      "completeLog": "",
      "progressMessages": [
        "9:13:15.926 PM Phase initialize started",
        "9:13:16.079 PM Phase initialize completed",
        "9:13:16.195 PM Phase patch started",
        "9:13:16.308 PM Phase patch-rex started",
        "9:15:03.436 PM Phase patch-rex completed",
        "9:15:03.697 PM Phase patch completed",
        "9:15:03.814 PM Phase finalize started",
        "9:15:03.911 PM Completed"
      ]
    },
    "rollbackId": "234688",
    "rollbackVersion": "mysql 5.7.15",
    "currentPatchLevel": "mysql 5.7.16",
    "progressMessages": [
      "9:13:15.926 PM Phase initialize started",
      "9:13:16.079 PM Phase initialize completed",
      "9:13:16.195 PM Phase patch started",
      "9:13:16.308 PM Phase patch-rex started",
      "9:15:03.436 PM Phase patch-rex completed",
      "9:15:03.697 PM Phase patch completed",
      "9:15:03.814 PM Phase finalize started",
      "9:15:03.911 PM Completed"
    ]
  }
]