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

View All Available Patches

get

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

Returns a list of all available 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 contains information about the available patches.
Root Schema : patch-available-response
Type: object
The response body contains information about the available patches.
Show Source
Nested Schema : availablePatchGuiMetadata
Type: object
Instruction to the metadata GUI about the 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 : patchCustomActions
Type: array
List of customer actions during patching.
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

Examples

The following example shows how to view a list of available patches 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/patches/available

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 30 Nov 2016 20:23:03 GMT
Server: Oracle-Application-Server-11g
Content-Length: 1544
X-ORACLE-DMS-ECID: 70Id0LGzY0z2NcfS0002sAIci5Nq00G0pH
X-ORACLE-DMS-ECID: 70Id0LGzY0z2NcfS0002sAIci5Nq00G0pH
X-Frame-Options: DENY
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
Access-Control-Allow-Origin: *
Content-Language: en
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Vary: Accept-Encoding,User-Agent
Content-Type: application/json
Set-Cookie: BIGipServerc1sa112_dc1_psm=213548112.28161.0000; path=/

Example of Response Body

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

[
    {
        "availablePatchGuiMetadata": {
            "supportsPreCheck": true
        },
        "patchId": "5.7.16-EE",
        "patchNumber": "5.7.16",
        "patchCategory": "Upgrade",
        "patchSeverity": "Normal",
        "includesConfigUpgrade": false,
        "patchDescription": "MySQL Server version 5.7.16",
        "patchReleaseUrl": "https:\/\/dev.mysql.com\/doc\/relnotes\/mysql\/5.7\/en\/news-5-7-16.html",
        "serviceType": "MySQLCS",
        "serviceVersion": "5.7",
        "releaseDate": "2016-10-12T09:00:00.000+0000",
        "entryDate": "2016-11-28T21:58:04.226+0000",
        "entryUserId": "OCLOUD9_TAS_APPID",
        "componentPatches": {
            "mysql": {
                "id": 2801,
                "version": "5.7",
                "releaseVersion": "5.7.16",
                "displayName": "MySQL Server version 5.7.16",
                "description": "MySQL Server version 5.7.16",
                "zipBundles": {
                    "MSAAS": {
                        "id": 2967,
                        "md5sum": "cc134947c4e3d5d0f644ef3b9bd52115",
                        "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": 2801,
                "component": "mysql",
                "version": "5.7",
                "md5sum": "cc134947c4e3d5d0f644ef3b9bd52115",
                "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",
        "requiresRestart": true,
        "serviceTypeVersions": "ANY",
        "isDeleted": false,
        "isCustomerVisible": false,
        "isAutoApply": false,
        "induceDownTime": false,
        "displayName": "5.7.16",
        "supportedStrategy": "In Place",
        "releaseVersion": "5.7.16",
        "patchCustomActions": [

        ]
    }
]