Jump to

• Request
• Response
• Examples

Perform a Patching Precheck

put

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/checks/{patchId}

Performs a precheck to identify potential issues that might prevent the specified patch from completing successfully without actually patching the service instance. Specifically, the patching precheck reports on the following conditions:

• Disk space shortage
• Database connectivity failure
• Server access failure
• Storage access failure

Prechecks do not check whether another administration task (such as backup, restoration, or scaling) is in progress, which would prevent patching.

Note: Patching is not supported for Oracle Java Cloud Service instances if you have installed any product that modifies MW_HOME (such as Oracle WebCenter Portal and Oracle Data Integrator). Patching is also not supported if you are reusing a license via the Bring Your Own License (BYOL) entitlement (for any product that modifies MW_HOME). Because patching replaces the contents of MW_HOME, patching prechecks flag this condition and patching fails.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Java Cloud Service account.
• patchId: string
  ID of the patch to precheck.
• serviceId: string
  Name of the Oracle Java Cloud Service instance.

Header Parameters

• Authorization: string
  Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Java Cloud Service account.

Body ()

The request contains information about the patch precheck operation.

Root Schema : precheck-request

The request consumes an application/json payload. No parameters are supported in the payload at this time.

Back to Top

Response

Supported Media Types

• application/json

202 Response

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

Headers

• Location: string
  A REST URI you can use to check the progress and completion of the precheck operation.

Body ()

Root Schema : patch-response

Type: object

The response body includes information about the operation.

Show Source

• details(optional): object details
  Groups the details of the operation.
• status(optional): string
  Status of the operation. When first initiated, the status is set to New. The status may transition to one of the following values: Completed and Cannot Complete

{
    "description":"The response body includes information about the operation.",
    "properties":{
        "details":{
            "type":"object",
            "description":"Groups the details of the operation.",
            "properties":{
                "jobId":{
                    "type":"string",
                    "description":"Job ID for the patch operation or patch precheck operation."
                },
                "message":{
                    "type":"string",
                    "description":"System message that describes the operation."
                }
            }
        },
        "status":{
            "type":"string",
            "description":"Status of the operation. When first initiated, the status is set to <code>New</code>. The status may transition to one of the following values: <code>Completed</code> and <code>Cannot Complete</code>"
        }
    }
}

Nested Schema : details

Type: object

Groups the details of the operation.

Show Source

• jobId(optional): string
  Job ID for the patch operation or patch precheck operation.
• message(optional): string
  System message that describes the operation.

{
    "type":"object",
    "description":"Groups the details of the operation.",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Job ID for the patch operation or patch precheck operation."
        },
        "message":{
            "type":"string",
            "description":"System message that describes the operation."
        }
    }
}

Back to Top

Examples

The following example shows how to perform a patch precheck by submitting a PUT request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command and Request Body

curl -i -X PUT -u username:password -d @emptyfile.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/patches/checks/Patch_jdk1.7.0_95

No parameters are supported in the request payload at this time.

Example of Response Header

The following shows an example of the response header.

The Location header returns the REST resource that can be used to access the status of the patch precheck operation. See View the Status of a Patching Precheck Operation.

HTTP/1.0 200 Connection established

HTTP/1.1 202 Accepted
Location: https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/JaaS/instances/ExampleInstance/patches/checks/job/5409198
Content-Language: en
Content-Type: application/json
Date: Thu, 11 May 2017 16:59:21 GMT

Example of Response Body

The following are examples of the response body in JSON format.

{
   "status":"Completed",
   "details":{
       "message":"PATCHING-5227: Pre-Checking service for patch [wls_patch_12.2.1.2.0_170326]
is submitted as an asynchronous job.",
       "jobId":"5409198"
   }
}

Back to Top