View Applied Patches
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/applied
Request
-
identityDomainId: string
The value depends on the type of Exadata Cloud at Customer account that is used to make the request:
For a Traditional Cloud Account, specify the
Identity Domain Name
that is associated with the service.For a Cloud Account with Identity Cloud Service, specify the
Identity Service Id
that is associated with the service, which is a character string beginning withidcs-
.
-
serviceId: string
Name of the Exadata Cloud at Customer deployment.
-
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
The value depends on the type of Exadata Cloud at Customer account that is used to make the request:
For a Traditional Cloud Account, specify the
Identity Domain Name
that is associated with the service.For a Cloud Account with Identity Cloud Service, specify the
Identity Service Id
that is associated with the service, which is a character string beginning withidcs-
.
For more information, see Security, Authentication and Authorization.
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
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
Information about the results of the rollback operation, which 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 Exadata Cloud at Customer deployment 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 information about all patches applied to an Exadata Cloud at Customer database deployment by submitting a GET request on the REST endpoint using cURL.
In this example, the identity domain is usexample
, the Exadata Cloud at Customer database deployment is db12c
and the Oracle Cloud user name and password are serviceadmin
and Pa55_word
.
cURL Command
curl -i -X GET --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample" https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db12c/patches/applied
HTTP Status Code and Response Headers
HTTP/2.0 200 server: Oracle-Application-Server-11g strict-transport-security: max-age=31536000;includeSubDomains content-language: en access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD x-oracle-dms-ecid: 005KBF2qU1_6uHFpR0H7id00067c0003YG x-oracle-dms-ecid: 005KBF2qU1_6uHFpR0H7id00067c0003YG access-control-allow-origin: * x-frame-options: DENY content-type: application/json vary: user-agent date: Tue, 30 May 2017 01:31:22 GMT content-length: 1734
Response Body
[{ "backupStatus": "Available", "additionalNote": "Patch applied using REST API", "appliedBy": "serviceadmin", "appliedDate": "2017-05-30T00:03:33.534+0000", "totalTime": "67 min, 12 sec", "patchId": "24968615", "patchDescription": "DB 12.1.0.2.170117 QUARTERLY DATABASE PATCH FOR EXADATA - JAN2017", "patchReleaseUrl": "https://support.oracle.com/epmos/faces/PatchDetail?patchId\u003d24968615", "releaseDate": "2017-01-17T01:40:00.000+0000", "lastStatus": "COMPLETED", "lastStatusMessage": "Completed", "componentPatches": { "EXADATA": { "id": 2651, "version": "12.1.0.2.170117", "releaseVersion": "12.1.0.2.170117", "zipBundles": { "EXADATA": { "id": 4721, "md5sum": "48a8623500c7f4b50e703011a1cfeb67", "storageKey": "PATCH/DB/12c/database.zip", "zipVersion": "12.1.0.2.170117" } }, "preserveFiles": [] } }, "patchType": "PSU", "patchCategory": "DB", "patchSeverity": "Normal", "jobId": "12223582", "displayName": "12.1.0.2.170117", "inProgress": false, "operationType": "None", "id": 505609, "patchingResult": { "patchingId": 455908, "versionBeforeThisPatch": "EXADATA 12.1.0.2.161018", "strategy": "Rolling", "releaseVersionBeforeThisPatch": "12.1.0.2", "customRollbackId": "12223582_1496102613534", "startDate": "2017-05-30T00:03:33.534+0000", "endDate": "2017-05-30T01:10:46.198+0000", "patchingStatus": "COMPLETED", "additionalNote": "Patch applied using REST API", "appliedBy": "serviceadmin", "jobId": "12223582", "completeLog": "", "progressMessages": ["12:03:33.398 AM Phase initialize started", "12:03:33.620 AM Phase initialize completed", "12:03:33.715 AM Phase patch started", "1:10:45.678 AM Phase patch completed", "1:10:45.877 AM Phase finalize started", "1:10:45.963 AM Completed"] }, "rollbackId": "505609", "rollbackVersion": "12.1.0.2", "currentPatchLevel": "12.1.0.2" } ]