View Applied Patches
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/applied
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
-
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
serviceId: string
Name of the Oracle Java Cloud Service instance.
-
filter(optional): string
String used to filter the results. Valid operatives include:
- =
- !=
- >=
- <=
For example, to filter the results on a specific patch category and type, set the filter as follows:
patchCategory=general,patchType!=security
. This value defaults tonull
.
-
Authorization: string
Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle Java Cloud Service account.
Response
- application/json
200 Response
array
-
Array of:
object applied-patch
Each object is a patch that has been applied.
object
-
additionalNote(optional):
string
Free-form text to provide additional information about the patch.
-
appliedBy(optional):
string
Name of the user that applied the patch.
system
displays if the patch was applied by an auto-update scheduled job. -
appliedDate(optional):
string
Date and time that the patch was applied.
-
appliedPatchGuiMetadata(optional):
object appliedPatchGuiMetadata
Instruction to the metadata UI about the patch.
-
backupId(optional):
string
Backup ID. You can use the backup ID to manage the backup.
-
backupStatus(optional):
string
Backup status in relation to the patch operation. Valid values include:
Available
,SameVersion
,Unavailable
,Unknown
. -
componentPatches(optional):
object componentPatches
A map that groups details of one or more components in the patch. A component could be WLS, OTD, JDK, OTD_JDK, or ORACLE_TOOLS.
-
currentPatchLevel(optional):
string
Current patch level for the component.
-
displayName(optional):
string
Display name of the patch.
-
id(optional):
integer
Unique ID of the patching operation. Use this ID to get details of a patching operation.
-
inProgress(optional):
boolean
Flag that specifies whether the patch is still in progress.
-
isUpgrade(optional):
boolean
Upgrade flag.
-
jobId(optional):
string
Job ID for the patch operation.
-
lastStatus(optional):
string
Status of the patch operation. For example:
IN PROGRESS
,COMPLETED
, andFAILED
.COMPLETED_ROLLBACK
is displayed when an applied patch has been rolled back. -
lastStatusMessage(optional):
string
Last message logged for the operation.
-
operationType(optional):
string
Patch operating being performed. Valid values include:
Rollback
,Patching
, andNone
. -
patchCategory(optional):
string
Category of the patch. For example:
General
,Multiple
,Security
, and so on. -
patchDescription(optional):
string
Description of the patch.
-
patchId(optional):
string
Patch ID.
-
patchingResult(optional):
object patching-result
Groups information about the results of the patch.
-
patchReleaseUrl(optional):
string
URL that provides more information about the patch.
-
patchSeverity(optional):
string
Severity of the patch. For example
Normal
,Mandatory
,Recommended
, and so on. -
patchType(optional):
string
Patch type classification. For example:
COMPOSITE
- composite patchJAAS_TOOLS
- Oracle Java Cloud Service tools updateJDK
- JDK updateJRF_UPDATE
- Oracle JRF updatePS
- patch setPSU
- patch set update
-
releaseDate(optional):
string
Date and time patch was released.
-
resultMessage(optional):
string
Patch results message.
-
rollbackId(optional):
string
ID of the rollback that is associated to the completed patching operation. The ID is used to rollback a patch operation.
-
rollbackResult(optional):
object rollback-result
Groups information about the results of the rollback operation. This attribute displays only when a rollback of the patch had been performed.
-
rollbackStatus(optional):
string
Rollback status in relation to the patch operation. Valid values include:
Available
,SameVersion
,Unavailable
,Unknown
. -
rollbackVersion(optional):
string
Version to which the patched component will be rolled back.
-
totalTime(optional):
string
Duration of the patch operation.
-
toVersion(optional):
string
Version of Oracle Java Cloud Service instance that was patched.
object
-
supportsPreRollbackCheck(optional):
boolean
Flag that indicates whether rollback precheck is supported via the web user interface.
object
-
componentname(optional):
object componentname
This attribute is the actual component name for the target service type. For example, an Oracle Java Cloud Service component name could be
WLS
. Each object is one component.
object
-
additionalNote(optional):
string
Free-form text to provide additional information about the patch.
-
appliedBy(optional):
string
Name of the user that applied the patch.
system
displays if the patch was applied by an auto-update scheduled job. -
backupId(optional):
string
Backup ID. You can use the backup ID to manage the backup.
-
completeLog(optional):
string
System messages that track the patch operations.
-
customRollbackId(optional):
string
ID to be used in a rollback operation.
-
endDate(optional):
string
Date the patch operation ended.
-
jobId(optional):
string
Job ID for the patch operation.
-
metaVersionBeforeThisPatch(optional):
string
Version of the metadata service manager before the patch was applied.
-
patchingId(optional):
integer
ID of the applied patch operation.
-
patchingStatus(optional):
string
Status of the patching operation. For example,
COMPLETED
.COMPLETED_ROLLBACK
is displayed when an applied patch has been rolled back. -
progressMessages(optional):
array progressMessages
List of progress messages for the patch.
-
releaseVersionBeforeThisPatch(optional):
string
Version of the software before the patch was applied.
-
resultMessage(optional):
string
System message that describes the patching operation.
-
startDate(optional):
string
Date and time that the patch operation started.
-
strategy(optional):
string
Patching strategy. For example,
Rolling
. To minimize service disruption, the patch is applied in a rolling pattern, patching a single node at a time. -
versionBeforeThisPatch(optional):
string
Version of the component or components before the patch was applied.
object
-
additionalNote(optional):
string
Free-form text to provide additional information about the rollback.
-
appliedBy(optional):
string
Name of the user that performed the rollback.
-
completeLog(optional):
string
System messages that track the rollback operations.
-
endDate(optional):
string
Date the rollback operation ended.
-
jobId(optional):
string
Job ID for the rollback operation.
-
patchingStatus(optional):
string
Status of the rollback operation. For example,
COMPLETED_ROLLBACK
. -
progressMessages(optional):
array progressMessages
List of progress messages for the rollback.
-
resultMessage(optional):
string
System message that describes the rollback operation.
-
rollbackId(optional):
integer
ID of the rollback operation.
-
startDate(optional):
string
Date and time that the rollback operation started.
object
WLS
. Each object is one component.-
id(optional):
integer
ID of a component patch.
-
releaseVersion(optional):
string
Component-level release version of the component patch.
-
version(optional):
string
Component version that the patch updated.
-
zipBundles(optional):
object zipBundles
Zips that contain the artifacts (for example, patched binaries or patches for the service volumes).
object
-
artifactname(optional):
object artifactname
This attribute is the actual artifact name for the target service type, component, and component version (for example,
JDK
or WLS). Each object is one artifact.
object
JDK
or WLS). Each object is one artifact.-
displayName(optional):
string
Display name for the artifact.
-
id(optional):
integer
ID that identifies the artifact.
-
md5sum(optional):
string
Checksum used to validate the artifact.
-
provisioningObjectRef(optional):
string
Location of binary to use when creating a new service instance.
-
releaseDate(optional):
string
Release date for the artifact.
-
releaseUrl(optional):
string
URL that provides more information about the artifact.
-
storageKey(optional):
string
Location of the patch artifact on the cloud.
-
zipVersion(optional):
string
Software version that is included in the artifact.
array
Examples
The following example shows how to view applied patches for an Oracle Java Cloud Service instance 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/applied
Example of Response Header
The following shows an example of the response header.
HTTP/1.0 200 Connection established
HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 10 Apr 2017 22:07:21 GMT
Example of Response Body
The following is an example of the response body in JSON format.
[
{
"backupStatus": "SameVersion",
"rollbackStatus": "SameVersion",
"additionalNote": "Rolling back patch wls_patch_12.2.1.2.2_180227",
"appliedBy": "username",
"appliedDate": "2018-04-25T16:37:04.910+0000",
"totalTime": "13 min, 20 sec",
"patchId": "wls_patch_12.2.1.2.2_180227",
"patchDescription": "WLS PIPELINE UPDATE 12.2.1.2.2",
"patchReleaseUrl": "https://support.oracle.com/epmos/faces/PatchDetail?patchId=26860993",
"releaseDate": "2018-02-27T01:40:00.000+0000",
"lastStatus": "COMPLETED_ROLLBACK",
"lastStatusMessage": "No errors",
"componentPatches": {
"OTD": {
"id": 15701,
"version": "12.2.1.2.4",
"releaseVersion": "12.2.1.2.180116",
"zipBundles": {
"OTD_JDK": {
"id": 51421,
"md5sum": "51c0768028b642cf3a37bfdb72550c3a",
"storageKey": "jcs/JDK/8.0.161/180116/jdk.zip",
"zipVersion": "1.8.0_161",
"releaseDate": "2018-01-16",
"releaseUrl": "http://www.oracle.com/technetwork/java/javase/8all-relnotes-2226344.html#R180_161",
"displayName": "OTD JDK"
}
},
"preserveFiles": []
},
"WLS": {
"id": 15702,
"version": "12.2.1.2.9",
"releaseVersion": "12.2.1.2.180227",
"expectedAppliedPatches": "opatch:26910516,19795066,19154304,21663638,22754279,19030178,19632480,18459080,18905788,19002423",
"zipBundles": {
"JDK": {
"id": 51422,
"md5sum": "51c0768028b642cf3a37bfdb72550c3a",
"storageKey": "jcs/JDK/8.0.161/180116/jdk.zip",
"zipVersion": "1.8.0_161",
"releaseDate": "2018-01-16",
"releaseUrl": "http://www.oracle.com/technetwork/java/javase/8all-relnotes-2226344.html#R180_161",
"displayName": "JDK"
},
"WLS": {
"id": 51423,
"md5sum": "0ce1fcf6dcd8abfec2cdeb843aa5bf96",
"storageKey": "jcs/FMW/12.2.1.2.2/180227/fmiddleware.zip",
"releaseDate": "2018-02-27",
"releaseUrl": "https://support.oracle.com/epmos/faces/PatchDetail?patchId=26860993",
"displayName": "Middleware"
}
},
"preserveFiles": []
}
},
"patchType": "PSU",
"patchCategory": "PATCH",
"patchSeverity": "Normal",
"jobId": "25321289",
"displayName": "12.2.1.2.180227",
"backupId": "e2618d09-ea9f-49b2-95f7-0fc2d1aba9ae",
"inProgress": false,
"operationType": "None",
"id": 719063,
"patchingResult": {
"patchingId": 622928,
"backupId": "e2618d09-ea9f-49b2-95f7-0fc2d1aba9ae",
"versionBeforeThisPatch": "OTD 12.2.1.2.180116,WLS 12.2.1.2.180120,SERVICEVERSION 12cRelease212",
"strategy": "Rolling",
"releaseVersionBeforeThisPatch": "12.2.1.2.180120",
"customRollbackId": "25217695_1524520377611",
"startDate": "2018-04-23T21:52:57.611+0000",
"endDate": "2018-04-23T22:06:44.006+0000",
"patchingStatus": "COMPLETED",
"resultMessage": "No errors",
"additionalNote": "Applying the patch wls_patch_12.2.1.2.2_180227",
"appliedBy": "username",
"jobId": "25217695",
"completeLog": "",
"progressMessages": [
"9:52:57.573 PM Phase initialize started",
"9:52:57.699 PM Phase initialize completed",
"9:52:57.920 PM patching.action.tools.phase_started",
"9:53:07.982 PM patching.action.tools.phase_completed",
"9:53:08.231 PM Phase backup started",
"9:55:14.958 PM Phase backup completed",
"9:55:15.185 PM patching.action.patch-pre-action.phase_started",
"9:55:15.381 PM patching.action.patch-pre-action.phase_completed",
"9:55:15.597 PM Phase patch started",
...
"10:06:37.495 PM Phase patch completed",
"10:06:37.742 PM patching.action.patch-post-action.phase_started",
"10:06:37.927 PM patching.action.patch-post-action.phase_completed",
"10:06:38.717 PM patching.action.patch-cleanup.phase_started",
"10:06:39.574 PM PSM-PATCH-60099: Removing any retained old artifacts",
"10:06:40.294 PM patching.progress.remove.left.over.binary.completed$jcs/FMW/12.2.1.2.2/180227/fmiddleware.zip$exampleinstance-wls-1",
"10:06:40.294 PM PSM-PATCH-60099: Removing any retained old artifacts",
"10:06:40.483 PM patching.progress.remove.left.over.binary.completed$jcs/JDK/8.0.161/180116/jdk.zip$exampleinstance-wls-1",
"10:06:43.488 PM patching.action.patch-cleanup.phase_completed",
"10:06:43.779 PM Phase finalize started",
"10:06:43.900 PM Completed"
]
},
"rollbackResult": {
"rollbackId": 3201,
"startDate": "2018-04-25T16:37:04.910+0000",
"endDate": "2018-04-25T16:50:25.485+0000",
"patchingStatus": "COMPLETED_ROLLBACK",
"resultMessage": "No errors",
"additionalNote": "Rolling back patch wls_patch_12.2.1.2.2_180227",
"appliedBy": "username",
"jobId": "25321289",
"completeLog": "",
"progressMessages": [
"4:37:04.905 PM Phase initialize started",
"4:37:05.000 PM Phase initialize completed",
"4:37:05.233 PM patching.action.tools.phase_started",
"4:37:15.185 PM patching.action.tools.phase_completed",
"4:37:15.483 PM patching.action.rollback-pre-action.phase_started",
"4:37:15.630 PM patching.action.rollback-pre-action.phase_completed",
"4:37:15.825 PM Phase rollback started",
...
"4:50:14.776 PM Phase rollback completed",
"4:50:15.040 PM patching.action.rollback-post-action.phase_started",
"4:50:15.240 PM patching.action.rollback-post-action.phase_completed",
"4:50:16.055 PM patching.action.rollback-cleanup.phase_started",
"4:50:17.059 PM PSM-PATCH-60099: Removing any retained old artifacts",
"4:50:17.511 PM patching.progress.remove.left.over.binary.completed$jcs/FMW/12.2.1.2.2/180119/fmiddleware.zip$exampleinstance-wls-1",
"4:50:17.511 PM PSM-PATCH-60099: Removing any retained old artifacts",
"4:50:17.650 PM patching.progress.remove.left.over.binary.completed$jcs/JDK/8.0.161/180116/jdk.zip$exampleinstance-wls-1",
"4:50:24.958 PM patching.action.rollback-cleanup.phase_completed",
"4:50:25.211 PM Phase finalize started",
"4:50:25.317 PM Completed"
]
},
"rollbackId": "719063",
"rollbackVersion": "12.2.1.2.180120",
"currentPatchLevel": "12.2.1.2.180120",
"isUpgrade": false,
"appliedPatchGuiMetadata": {
"supportsPreRollbackCheck": true
}
}
]
Note that rollbackResult
is displayed only if an applied patch has been rolled back.