View a List of Available Patches
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/available
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
object
-
availablePatchGuiMetadata(optional):
object availablePatchGuiMetadata
Instruction to the metadata UI about the patch.
-
componentPatches(optional):
array componentPatches
Group the details of each patches in the component.
-
displayName(optional):
string
Display name of the patch.
-
entryDate(optional):
string
Date and time the patch is created.
-
entryUserId(optional):
string
Name of the user that created the patch.
-
includesConfigUpgrade(optional):
boolean
Flag that indicates whether the patch includes a configuration upgrade.
-
isDeleted(optional):
boolean
Flag that indicates whether the patch has been deleted and is no longer available. The information about the patch is not removed from the list of available patches in order to maintain an historical record of all patches.
-
metaVersion(optional):
string
The release version of metadata service manager.
-
patchCategory(optional):
string
Category of the patch. For example:
General
,Upgrade
,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.
-
patchNumber(optional):
string
Patch number.
-
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,
PSU
,Security
. -
releaseDate(optional):
string
Date and time the patch is released.
-
releaseVersion(optional):
string
Release version of the component in this patch.
-
requiresRestart(optional):
boolean
Flag that indicates whether the patch requires a restart of the service instance.
-
serviceType(optional):
string
Service type
dbaas
. -
serviceTypeVersions(optional):
string
Oracle Database Classic Cloud Service instance version to which the patch can be applied. For example:
11.2.0.7
,Any
, whereAny
indicates that the patch can be applied to any version. -
serviceVersion(optional):
string
Oracle Database Classic Cloud Service instance version to which the patch can be applied. For example:
11.2.0.4
,Any
, whereAny
indicates that the patch can be applied to any version. -
supportedStrategy(optional):
string
Supported patching strategy. For example:
In Place
.
object
-
supportsPreCheck(optional):
boolean
Flag that indicates whether the patch supports precheck via UI.
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
-
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
Examples
The following example shows how to view a list of available 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/available
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: 1729 Connection: keep-alive
Response Body
[ { "availablePatchGuiMetadata": { "supportsPreCheck": true }, "lastprePreCheckResult": { "id": 1887, "jobId": "3371498", "patchId": "24006101-EE", "jsonResult": "{\"resultMessage\":\"Completed\",\"messages\":[]}", "startDate": "2016-12-22T19:20:21.318+0000", "endDate": "2016-12-22T19:21:33.029+0000", "performedBy": "dbcsadmin", "inProgress": false, "status": "PASSED_PRECHECK", "preCheckMessages": [], "statusMessage": "Completed" }, "patchId": "24006101-EE", "patchNumber": "Patch_12.1.0.2.161018_EE", "patchCategory": "DB", "patchSeverity": "Normal", "includesConfigUpgrade": false, "patchDescription": "DB 12.1.0.2.161018 Oct 2016 PSU Enterprise Edition image", "patchReleaseUrl": "https:\/\/support.oracle.com\/epmos\/faces\/PatchDetail?patchId=24006101", "serviceType": "DBaaS", "serviceVersion": "12.1.0.2", "releaseDate": "2016-10-18T01:40:00.000+0000", "entryDate": "2016-12-10T03:09:25.943+0000", "entryUserId": "OCLOUD9_SM_PLATFORM_APPID", "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", "requiresRestart": true, "serviceTypeVersions": "ANY", "isDeleted": false, "isCustomerVisible": false, "isAutoApply": false, "induceDownTime": false, "displayName": "12.1.0.2.161018", "releaseVersion": "12.1.0.2.161018", "serviceEditions": "EE,EE_HP,EE_EP", "patchCustomActions": [] } ]