1. REST API for Oracle Java Cloud Service
  2. Tasks
  3. Patches

View the Status of a Patching Precheck Operation

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/checks/job/{jobId}

Returns the status of a patching precheck operation.

If the precheck does not pass, check the preCheckMessages attribute for more information.

Note: Patching is not supported for Oracle Java Cloud Service instances if you have installed any product that modifies MW_HOME (such as Oracle WebCenter Portal and Oracle Data Integrator). Patching is also not supported if you are reusing a license via the Bring Your Own License (BYOL) entitlement (for any product that modifies MW_HOME). Because patching replaces the contents of MW_HOME, patching prechecks flag this condition and patching fails.

Request

Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : view-precheck
Type: object
The response body includes information about the patch precheck. When viewing all patching prechecks, the response body includes information about all patch prechecks executed on this service instance.
Show Source
Nested Schema : preCheckMessages
Type: array
List of precheck messages. No messages are returned when the precheck completes successfully.
Show Source
Nested Schema : precheckResultItems
Type: array
List of precheck result items. No items are returned when the precheck completes successfully.
Show Source
Back to Top

Examples

The following example shows how to view the status of a patch precheck by submitting a GET request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/patches/checks/job/5409198

Example of Response Header

The following shows an example of the response header when the request is submitted:

HTTP/1.0 200 Connection established

HTTP/1.1 200 OK
Content-Language: en
Content-Location: https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/JaaS/instances/ExampleInstance/patches/checks/job/5409198
Content-Type: application/json
Date: Thu, 11 May 2017 17:02:27 GMT
Content-Length: 353
Connection: keep-alive

Example of Response Body

The following shows an example of the response body in JSON format where the precheck operation is still in progress.

{
   "id":3852,
   "jobId":"5334141",
   "patchId":"wls_patch_12.2.1.2.0_170326",
   "jsonResult":"{\"messages\":[]}",
   "startDate":"2017-05-08T20:56:59.529+0000",
   "endDate":"2017-05-08T20:56:59.745+0000",
   "performedBy":"username",
   "inProgress":true,
   "status":"IN_PROGRESS",
   "preCheckMessages":[]
}

The following shows an example of the response body in JSON format where the operation is completed and the precheck has passed.

{
   "id":3902,
   "jobId":"5409198",
   "patchId":"wls_patch_12.2.1.2.0_170326",
   "jsonResult":"{\"resultMessage\":\"Completed\",\"messages\":[]}",
   "startDate":"2017-05-11T16:59:21.780+0000",
   "endDate":"2017-05-11T17:00:59.047+0000",
   "performedBy":"username",
   "inProgress":false,
   "status":"PASSED_PRECHECK",
   "preCheckMessages":[],
   "statusMessage":"Completed"
}

The following shows an example of a response body where the operation is completed but the precheck did not pass.

{
   "id":3852,
   "jobId":"5334141",
   "patchId":"wls_patch_12.2.1.2.0_170326",
   "jsonResult":"{\"resultMessage\":\"PATCHING-5336: Unable to retrieve list of running WLS servers from Admin server [JCSABCD__adminserver] on host [jcsabcd-wls-1] using WLST. Please check the Admin server logs to determine what caused the failure. You can refer to Oracle Fusion Middleware documentation for further details.\",\"messages\":[\"PATCHING-5336: Unable to retrieve list of running WLS servers from Ad
min server [JCSABCD__adminserver] on host [jcsabcd-wls-1] using WLST. Please check the Admin server logs to determine what caused the failure. You can refer to Oracle Fusion Middleware documentation for further details.\"]
   }",
   "startDate":"2017-05-08T20:56:59.529+0000",
   "endDate":"2017-05-08T20:58:33.461+0000",
   "performedBy":"username",
   "inProgress":false,
   "status":"DIDNT_PASS_PRECHECK",
   "preCheckMessages":[],
   "statusMessage":"PATCHING-5336: Unable to retrieve list of running WLS servers from Admin server [JCSABCD__adminserver] on host [jcsabcd-wls-1] using WLST. Please check the Admin server logs to determine what caused the failure. You can refer to Oracle Fusion Middleware documentation for further details."
}
Back to Top