View Status of All Patching Precheck Operations
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/patches/checks
Request
-
identityDomainId: string
Name of the identity domain for the MySQL Cloud Service account.
-
serviceId: string
The user-defined name of the Oracle MySQL Cloud Service instance.
-
X-ID-TENANT-NAME: string
Name of the identity domain for the MySQL Cloud Service account.
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.
-
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.
-
resultMessage(optional):
string
System messages. This attribute displays only when viewing the status of one patching precheck operation.
-
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.
array
Examples
The following example shows how to view a list of patch prechecks performed on a MySQL Cloud Service instance by submitting a GET request on the REST endpoint using cURL.
Note: The command in this example uses the URL structure https://rest_server_url/resource-path
, where rest_server_url
is the Oracle Public Cloud or Oracle Cloud Machine REST server to contact for your identity domain or tenant name. See Send Requests for the appropriate URL structure to use on Oracle Public Cloud or Oracle Cloud Machine.
cURL Command
curl -i -X GET \
-u "username:password" \
-H "X-ID-TENANT-NAME: ExampleIdentityDomain" \
-H "Accept: application/json" \
https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/patches/checks
Example of Response Header
The following shows an example of the response header.
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: 001GsqvOtGZ6uHFpR05Eid0003Vg0003GI
X-ORACLE-DMS-ECID: 001GsqvOtGZ6uHFpR05Eid0003Vg0003GI
Access-Control-Allow-Origin: *
X-Frame-Options: DENY
Content-Type: application/json
Vary: user-agent
Date: Tue, 13 Dec 2016 17:41:37 GMT
Content-Length: 459
Connection: keep-alive
Example of Response Body
The following shows an example of the response body in JSON format.
[{ "id": 2759, "jobId": "4202954", "patchId": "5.7.16-EE", "startDate": "2016-12-13T17:25:38.616+0000", "endDate": "2016-12-13T17:26:02.801+0000", "performedBy": "someone@example.org", "inProgress": false, "status": "PASSED_PRECHECK", "href": "https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/patches/checks/job/4202954", "preCheckMessages": [], "statusMessage": "Precheck operation got successful" }]