View the Status of a Patching Precheck Operation
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/checks/job/{jobId}
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-
.
-
jobId: string
Job ID of the operation that was returned when the patching precheck was initiated.
-
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
202 Response
object
-
endDate(optional):
string
Date and time that the patching precheck operation stopped.
-
href(optional):
string
URL for checking the status of the patching precheck job. This attribute displays only when viewing all patching precheck operations.
-
id(optional):
integer
ID of the operation.
-
inProgress(optional):
boolean
Flag that specifies whether the patch precheck is still in progress.
-
jobId(optional):
string
Job ID for the patching precheck operation.
-
jsonResult(optional):
object jsonResult
System messages. This attribute displays only when viewing the status of one patching precheck operation.
-
patchId(optional):
string
Patch ID.
-
performedBy(optional):
string
Name of the user account used to perform the patch precheck.
-
preCheckMessages(optional):
array preCheckMessages
List of patching precheck messages. No patching precheck messages are returned when the precheck completes successfully.
-
startDate(optional):
string
Date and time that the patching precheck operation started.
-
status(optional):
string
Status of the patching precheck operation. Valid values include:
PASSED_PRECHECK
- Patching precheck passed.DIDNT_PASS_PRECHECK
- Patching precheck did not pass. Check thepreCheckMessages
attribute for more information.DIDNT_FINISHED_PRECHECK
- An internal error was encountered and the patching precheck could not be performed.
object
-
messages(optional):
array messages
Precheck status detailed messages, if any.
-
statusMessage(optional):
string
Describes the status of the executed precheck and describes if the operation completed or encountered any errors.
array
Examples
The following example shows how to view information about the status of a specific patch precheck operation associated with 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
. The job identification number for the patch precheck operation is 12221158
.
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/checks/job/12221158
HTTP Status Code and Response Headers
HTTP/2.0 202 server: Oracle-Application-Server-11g strict-transport-security: max-age=31536000;includeSubDomains content-language: en content-location: https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/DBaaS/instances/db12c/patches/checks/job/12221158 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: 005KB9Q6YWA6uHFpR05Eid0007dd00010v x-oracle-dms-ecid: 005KB9Q6YWA6uHFpR05Eid0007dd00010v access-control-allow-origin: * x-frame-options: DENY content-type: application/json vary: user-agent date: Mon, 29 May 2017 23:50:30 GMT
Response Body
{ "id": 7769, "jobId": "12221158", "patchId": "24968615", "jsonResult": "{\"messages\":[]}", "startDate": "2017-05-29T23:47:35.175+0000", "endDate": "2017-05-29T23:47:35.285+0000", "performedBy": "serviceadmin", "inProgress": true, "status": "IN_PROGRESS", "preCheckMessages": [] }