Jump to

• Request
• Response
• Examples

Apply a Patch

put

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

Applies a patch to a MySQL Cloud Service instance.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Name of the identity domain for the MySQL Cloud Service account.
• patchId: string
  Patch ID. The patch ID can be retrieved via getting the list of available patches.
• 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.

Body ()

The request body contains details about the patch request. A request body is required, so either pass in the desired options, or use an empty object {}.

Root Schema : patch-apply-request-request

Type: object

The request body contains information about the patch request. All attributes are optional.

Show Source

• additionalNote(optional): string
  Free-form text to provide additional information about the patch request.

{
    "description":"The request body contains information about the patch request. All attributes are optional.",
    "properties":{
        "additionalNote":{
            "type":"string",
            "description":"Free-form text to provide additional information about the patch request."
        }
    }
}

Response

Supported Media Types

• application/json

202 Response

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

Body ()

Root Schema : Response Body

Type: object

Title: Response Body

The response body contains information about the operation.

Show Source

• jobId(optional): string
  Job ID for the operation.
• message(optional): string
  System message that describes the operation. For example: Submitted job to create service [{serviceId}] in domain [{identityDomainId}].

{
    "title":"Response Body",
    "description":"The response body contains information about the operation.",
    "properties":{
        "message":{
            "description":"System message that describes the operation. For example: <code>Submitted job to create service [{serviceId}] in domain [{identityDomainId}].</code>",
            "type":"string"
        },
        "jobId":{
            "description":"Job ID for the operation.",
            "type":"string"
        }
    }
}

Examples

The following example shows how to apply a patch to a MySQL Cloud Service instance by submitting a PUT 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 PUT \
  -u "username:password" \
  -H "X-ID-TENANT-NAME: ExampleIdentityDomain" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{'additionalNote': 'Applying 5.7.16-EE patch as discussed with team on KB-43123.'}" \
  https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/patches/5.7.16-EE

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 202 Accepted
Server: Oracle-Application-Server-11g
Location: https://rest_server_url:433/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/patches/applied/job/4207169
Content-Language: en
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Retry-After: 60
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: 004Gt2kHHrD6uHFpR05Eid0003Vg0000bC
X-ORACLE-DMS-ECID: 004Gt2kHHrD6uHFpR05Eid0003Vg0000bC
Access-Control-Allow-Origin: *
X-Frame-Options: DENY
Content-Type: application/json
Vary: user-agent
Date: Tue, 13 Dec 2016 21:13:15 GMT
Connection: close

Example of Response Body

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

{
	"status": "Completed",
	"details": {
		"message": "PATCHING-5068: Patching service with patch [5.7.16-EE] is submitted as an asynchronous job.",
		"jobId": "4207169"
	}
}