Jump to

• Request
• Response
• Examples

Precheck Application of a Patch

put

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

Performs a precheck operation to identity potential issues that might prevent the specified patch from successfully completing. Specifically, the patching precheck reports on the following conditions:

• Disk space shortage
• Database connectivity failure
• Server access failure
• Storage access failure

Prechecks do not check whether another administration task (such as backup, restoration, or scaling) is in progress, which would prevent patching.

Request

Path Parameters

• identityDomainId: string
  Name of the identity domain for the MySQL Cloud Service account.
• patchId: string
  ID of the patch to precheck.
• 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

202 Response

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

The Location header returns a REST URI that can be used to access the status of the patching precheck operation.

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 precheck application of 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.

Note: Sending a request body is always required, but it may be empty as demonstrated in this example.

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 "{}" \
   https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/patches/checks/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:443/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/patches/checks/job/4208351
Content-Language: en
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Retry-After: 10
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: 001GtDpPY4t6uHFpR0H7id0006BS00046i
X-ORACLE-DMS-ECID: 001GtDpPY4t6uHFpR0H7id0006BS00046i
Access-Control-Allow-Origin: *
X-Frame-Options: DENY
Content-Type: application/json
Vary: user-agent
Date: Wed, 14 Dec 2016 00:31:32 GMT
Connection: close

Example of Response Body

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

{
  "status": "Completed",
  "details": {
    "message": "PATCHING-5227: Pre-Checking service for patch [5.7.16-EE] is submitted as an asynchronous job.",
    "jobId": "4208351"
  }
}