Apply a Patch
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/{patchId}
Request
- application/json
-
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-
.
-
patchId: string
Patch ID. The patch ID can be retrieved via getting the list of available patches.
-
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.
object
Request Body
-
additionalNote(optional):
string
Free-form text to provide additional information about the patching operation.
-
forceApply(optional):
boolean
Specifies whether the patch should be applied even if the precheck finds conflicts. Valid values are
true
andfalse
. Whentrue
is specified, patch conflicts or errors discovered during the precheck stage of the patching operation are ignored and the patch is applied (space permitting). Otherwise, if conflicts or errors are discovered, the patch is not applied.Default value is
false
. -
switchOver(optional):
boolean
Specifies whether a Data Guard switchover operation is performed on the primary database before applying the patch. Valid values are
true
andfalse
.Default value is
false
.(Applicable only to deployments associated with a Data Guard configuration.)
Response
- application/json
202 Response
object
Response Body
-
details(optional):
object Details Object
Title:
Details Object
-
status(optional):
string
Status of the request to start a job for the operation. Usually the value
Completed
.
object
Details Object
-
jobId(optional):
string
Job ID of the job that was started to perform the operation.
-
message(optional):
string
Message describing the operation.
Examples
The following example shows how to apply a patch on an Exadata Cloud at Customer database deployment by submitting a PUT request on the REST endpoint using cURL.
In this example, the identity domain is usexample
and the Oracle Cloud user name and password are serviceadmin
and Pa55_word
. The name of the database deployment is db12c
and the patch identification number is 24968615
.
cURL Command
In the following cURL command, the request body is provided directly in the -d
option.
curl -i -X PUT --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample" -H "Content-Type:application/json" -d '{ "additionalNote" : "Patch applied using REST API" }' https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db12c/patches/24968615
HTTP Status Code and Response Headers
HTTP/2.0 202 server: Oracle-Application-Server-11g strict-transport-security: max-age=31536000;includeSubDomains location: https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/DBaaS/instances/db12c/patches/applied/job/12223582 content-language: en access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME retry-after: 60 access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD x-oracle-dms-ecid: 005KBA7ktGU6uHFpR0H7id00067c0002Zx x-oracle-dms-ecid: 005KBA7ktGU6uHFpR0H7id00067c0002Zx access-control-allow-origin: * x-frame-options: DENY content-type: application/json vary: user-agent date: Tue, 30 May 2017 00:03:33 GMT
Response Body
{ "status": "Completed", "details": { "message": "PATCHING-5068: Patching service with patch [24968615] is submitted as an asynchronous job.", "jobId": "12223582" } }