Jump to

• Request
• Response
• Examples

View Status of a Patching Precheck Operation

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/patches/checks/job/{jobId}

Returns the status of a patching precheck operation.

Request

Path Parameters

• identityDomainId: string
  Name of the identity domain for the MySQL Cloud Service account.
• jobId: string
  Job ID of the operation that was returned when the patching precheck was initiated.
• serviceId: string
  The user-defined name of the Oracle MySQL Cloud Service instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Name of the identity domain for the MySQL Cloud Service account.

Response

Supported Media Types

• application/json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Body ()

The response body includes information about the patch precheck. When viewing all patching prechecks, the response body includes information about all patch prechecks executed on this service instance.

Root Schema : patch-precheck-view-response

Type: object

The response body includes information about the patch precheck. When viewing all patching prechecks, the response body includes information about all patch prechecks executed on this service instance.

Show Source

• 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 the preCheckMessages attribute for more information.
  • DIDNT_FINISHED_PRECHECK - An internal error was encountered and the patching precheck could not be performed.

{
    "description":"The response body includes information about the patch precheck. When viewing all patching prechecks, the response body includes information about all patch prechecks executed on this service instance.",
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID of the operation."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID for the patching precheck operation."
        },
        "patchId":{
            "type":"string",
            "description":"Patch ID."
        },
        "startDate":{
            "type":"string",
            "description":"Date and time that the patching precheck operation started."
        },
        "endDate":{
            "type":"string",
            "description":"Date and time that the patching precheck operation stopped."
        },
        "performedBy":{
            "type":"string",
            "description":"Name of the user account used to perform the patch precheck."
        },
        "inProgress":{
            "type":"boolean",
            "description":"Flag that specifies whether the patch precheck is still in progress."
        },
        "status":{
            "type":"string",
            "description":"Status of the patching precheck operation. Valid values include: <ul><li><code>PASSED_PRECHECK</code> - Patching precheck passed.</li><li><code>DIDNT_PASS_PRECHECK</code> - Patching precheck did not pass. Check the <code>preCheckMessages</code> attribute for more information.</li><li><code>DIDNT_FINISHED_PRECHECK</code> - An internal error was encountered and the patching precheck could not be performed."
        },
        "href":{
            "type":"string",
            "description":"URL for checking the status of the patching precheck job. This attribute displays only when viewing all patching precheck operations."
        },
        "preCheckMessages":{
            "type":"array",
            "description":"List of patching precheck messages. No patching precheck messages are returned when the precheck completes successfully.",
            "items":{
                "type":"string"
            }
        },
        "resultMessage":{
            "type":"string",
            "description":"System messages. This attribute displays only when viewing the status of one patching precheck operation."
        }
    }
}

Nested Schema : preCheckMessages

Type: array

List of patching precheck messages. No patching precheck messages are returned when the precheck completes successfully.

Show Source

• [0]: string

{
    "type":"array",
    "description":"List of patching precheck messages. No patching precheck messages are returned when the precheck completes successfully.",
    "items":{
        "type":"string"
    }
}

Examples

The following example shows how to view a specific patch precheck operation (job) 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" \
  -H "Content-Type: application/json" \
  -d "{}" \
  https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/patches/checks/job/4202954

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
Content-Location: https://rest_server_url:443/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/patches/checks/job/4202954
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: 001Gsqo4OvN6uHFpR0H7id0006BS0003Ik
X-ORACLE-DMS-ECID: 001Gsqo4OvN6uHFpR0H7id0006BS0003Ik
Access-Control-Allow-Origin: *
X-Frame-Options: DENY
Content-Type: application/json
Vary: user-agent
Date: Tue, 13 Dec 2016 17:39:34 GMT
Content-Length: 384
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",
	"jsonResult": "{\"resultMessage\":\"Precheck operation got successful\",\"messages\":[]}",
	"startDate": "2016-12-13T17:25:38.616+0000",
	"endDate": "2016-12-13T17:26:02.801+0000",
	"performedBy": "[e-mail]",
	"inProgress": false,
	"status": "PASSED_PRECHECK",
	"preCheckMessages": [],
	"statusMessage": "Precheck operation got successful"
}