View a List of Applied and Rolled Back Patches
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/applied
Request
-
identityDomainId: string
Identity domain ID for the Database Classic Cloud Service account:
For a Cloud account with Identity Cloud Service: the identity service ID, which has the form
idcs-letters-and-numbers
. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.For a traditional cloud account: the name of the identity domain.
-
serviceId: string
Name of the Database Classic Cloud Service instance.
-
Authorization: string
Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Database Classic Cloud Service account:
For a Cloud account with Identity Cloud Service: the identity service ID, which has the form
idcs-letters-and-numbers
. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.For a traditional cloud account: the name of the identity domain.
Response
- application/json
200 Response
array
-
Array of:
object applied-patch
Information about an applied patch.
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.
-
backupId(optional):
string
Backup ID. You can use the backup ID to manage the backup.
-
backupStatus(optional):
string
Whether a backup of the software was created before the patch was applied. Valid values include:
Available
,SameVersion
,Unavailable
,Unknown
. -
componentPatches(optional):
array componentPatches
Group the details of each patches in the component.
-
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.
-
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 patch 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. -
patchComponents(optional):
array patchComponents
Group the details of the patch to be applied.
-
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,
Quarterly
,Security
. -
progressMessages(optional):
array progressMessages
List of progress messages for the patch.
-
releaseDate(optional):
string
Date and time patch was released.
-
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.
-
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 Database Classic Cloud Service instance that was patched.
array
-
Array of:
object component-patch
Group the details of each patch in the component.
array
-
Array of:
object patch-component
Group the details of the patch to be applied.
object
-
additionalNote(optional):
string
Free-form text to provide additional information about the rollback.
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
-
description(optional):
string
Brief description of the patch.
-
displayName(optional):
string
Display name of the component in this patch.
-
id(optional):
integer
ID of a component patch.
-
preserveFiles(optional):
array preserveFiles
List of files to be preserved during patching.
-
releaseVersion(optional):
string
Release version of the component in this patch.
-
version(optional):
string
Version of the patch component.
-
zipBundles(optional):
array zipBundles
Zips that contain the patched binaries or patches.
array
array
-
Array of:
object view-zip-bundles
Group the details of zips for the patched binaries.
object
-
displayName(optional):
string
Display name of this component.
-
id(optional):
integer
ID of a component patch.
-
md5sum(optional):
string
Checksum used to validate the patch binary.
-
provisioningObjectRef(optional):
string
Location of binary to use when creating a new service instance.
-
releaseDate(optional):
string
Release date of this version.
-
releaseUrl(optional):
string
URL for more information about this release.
-
storageKey(optional):
string
Location of the patch zip on the cloud.
-
zipVersion(optional):
string
Software version that is included in the zip.
object
-
component(optional):
string
Name of the component in this patch
db
. -
id(optional):
integer
ID of a component patch.
-
md5sum(optional):
string
Checksum used to validate the patch binary.
-
patchingObjectRef(optional):
string
Location of binary to use when patching a service instance.
-
preserveFiles(optional):
array preserveFiles
List of files to be preserved during patching.
-
provisioningObjectRef(optional):
string
Location of binary to use when creating a new service instance.
-
version(optional):
string
Version of the patch component.
array
array
Examples
The following example shows how to view a list of applied and rolled back patches by submitting a GET request on the REST endpoint using cURL.
This example uses a traditional cloud account, so the {identityDomainId}
path parameter and the X-ID-TENANT-NAME
header parameter are set to the account's domain name, which is mydomain
. The service instance is db121-ep-si
and the Oracle Cloud user name of the user making the call is dbcsadmin
.
cURL Command
curl --include --request GET \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:mydomain" \
https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/mydomain/services/dbaas/instances/db121-ep-si/patches/applied
HTTP Status Code and Response Headers
HTTP/1.0 200 Connection established HTTP/1.1 200 OK Server: Oracle-Application-Server-11g Content-Language: en Access-Control-Allow-Headers: Content-Type, api_key, Authorization Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD X-ORACLE-DMS-ECID: id-string X-ORACLE-DMS-ECID: id-string Access-Control-Allow-Origin: * X-Frame-Options: DENY Content-Type: application/json Vary: user-agent Date: date-and-time-stamp Content-Length: 2808 Connection: keep-alive
Response Body
[ { "backupStatus": "Unknown", "additionalNote": "Rolling back Oct 2016 PSU", "appliedBy": "dbcsadmin", "appliedDate": "2016-12-22T23:09:22.142+0000", "totalTime": "23 min, 6 sec", "patchId": "24006101-EE", "patchDescription": "DB 12.1.0.2.161018 Oct 2016 PSU Enterprise Edition image", "patchReleaseUrl": "https:\/\/support.oracle.com\/epmos\/faces\/PatchDetail?patchId=24006101", "releaseDate": "2016-10-18T01:40:00.000+0000", "resultMessage": "Completed", "lastStatus": "COMPLETED_ROLLBACK", "lastStatusMessage": "Completed", "componentPatches": { "DB": { "id": 1105, "version": "12.1.0.2.161018", "releaseVersion": "12.1.0.2.161018", "zipBundles": { "DB": { "id": 1074, "md5sum": "48a8623500c7f4b50e703011a1cfeb67", "provisioningObjectRef": "DB\/12c\/database.zip", "storageKey": "PATCH\/DB\/12c\/database.zip", "zipVersion": "12.1.0.2.161018" } }, "preserveFiles": [] } }, "patchComponents": [ { "id": 1105, "component": "DB", "version": "12.1.0.2.161018", "md5sum": "48a8623500c7f4b50e703011a1cfeb67", "provisioningObjectRef": "DB\/12c\/database.zip", "patchingObjectRef": "PATCH\/DB\/12c\/database.zip", "preserveFiles": [] } ], "patchType": "PSU", "patchCategory": "DB", "patchSeverity": "Normal", "jobId": "3373771", "displayName": "12.1.0.2.161018", "toVersion": "12.1.0.2.161018", "inProgress": false, "operationType": "None", "id": 78919, "patchingResult": { "patchingId": 60170, "versionBeforeThisPatch": "DB 12.1.0.2.160719", "strategy": "Rolling", "releaseVersionBeforeThisPatch": "12.1.0.2", "customRollbackId": "3375102_1482440121001", "startDate": "2016-12-22T20:55:21.001+0000", "endDate": "2016-12-22T21:30:54.526+0000", "patchingStatus": "COMPLETED", "resultMessage": "Completed", "additionalNote": "Applying Oct 2016 PSU", "appliedBy": "dbcsadmin", "jobId": "3375102", "completeLog": "", "progressMessages": [ "8:55:20.980 PM Phase initialize started", "8:55:21.038 PM Phase initialize completed", "8:55:21.104 PM Phase patch started", "9:30:54.244 PM Phase patch completed", "9:30:54.324 PM Phase finalize started", "9:30:54.373 PM Completed" ] }, "rollbackResult": { "rollbackId": 451, "startDate": "2016-12-22T23:09:22.142+0000", "endDate": "2016-12-22T23:32:28.232+0000", "patchingStatus": "COMPLETED_ROLLBACK", "resultMessage": "Completed", "additionalNote": "Rolling back Oct 2016 PSU", "appliedBy": "dbcsadmin", "jobId": "3373771", "completeLog": "", "progressMessages": [ "11:09:22.123 PM Phase initialize started", "11:09:22.185 PM Phase initialize completed", "11:09:22.237 PM Phase rollback started", "11:32:27.818 PM Phase rollback completed", "11:32:27.953 PM Phase finalize started", "11:32:28.044 PM Completed" ] }, "rollbackId": "78919", "currentPatchLevel": "DB 12.1.0.2.161018", "progressMessages": [ "11:09:22.123 PM Phase initialize started", "11:09:22.185 PM Phase initialize completed", "11:09:22.237 PM Phase rollback started", "11:32:27.818 PM Phase rollback completed", "11:32:27.953 PM Phase finalize started", "11:32:28.044 PM Completed" ] } ]