Perform a Patching Precheck
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/checks/{patchId}
- Disk space shortage
- Database connectivity failure
- Server access failure
- Storage access failure
Prechecks do not check whether another administration task (such as backup or restoration) is in progress, which would prevent patching.
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
ID of the patch to precheck.
-
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 precheck operation.
Response
- application/json
202 Response
The Location
header returns a REST URI that can be used to access the status of the patching precheck operation.
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 perform a patch precheck 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 precheck using REST API" }' https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db12c/patches/checks/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/checks/job/12221158 content-language: en access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME retry-after: 10 access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD x-oracle-dms-ecid: 005KB9F4Ru76uHFpR05Eid0007dd0002sd x-oracle-dms-ecid: 005KB9F4Ru76uHFpR05Eid0007dd0002sd access-control-allow-origin: * x-frame-options: DENY content-type: application/json vary: user-agent date: Mon, 29 May 2017 23:47:35 GMT
Response Body
{ "status": "Completed", "details": { "message": "PATCHING-5227: Pre-Checking service for patch [24968615] is submitted as an asynchronous job.", "jobId": "12221158" } }