View a List of Patch Precheck Operations
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/checks
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
-
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.
-
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 status of executed precheck. Describes if the operation completed or encountered any errors.
Examples
The following example shows how to view a list of patch prechecks performed 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/checks
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: 417 Connection: keep-alive
Response Body
[ { "id": 1887, "jobId": "3371498", "patchId": "24006101-EE", "startDate": "2016-12-22T19:20:21.318+0000", "endDate": "2016-12-22T19:21:33.029+0000", "performedBy": "dbcsadmin", "inProgress": false, "status": "PASSED_PRECHECK", "href": "https:\/\/dbaas.oraclecloud.com:443\/paas\/api\/v1.1\/instancemgmt\/mydomain\/services\/DBaaS\/instances\/db121-ep-si\/patches\/checks\/job\/3371498", "preCheckMessages": [], "statusMessage": "Completed" } ]