Jump to

• Request
• Response
• Examples

Perform a Patching Precheck

put

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/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.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Integration Classic account.
• patchId: string
  ID of the patch to precheck.
• service_name: string
  Name of the Oracle Integration Classic instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Integration Classic account.

Body ()

The request contains information about the patch precheck operation.

Root Schema : precheck-request

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

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted.

Headers

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

Body ()

The response body includes information about the operation.

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 precheck by submitting a PUT request on the REST resource using cURL.

Note:

The command in this example uses the URL structure https://example.com/resource-path, where example.com is the Oracle Cloud server to contact for your identity domain.

cURL Command

curl -i -X PUT -u jstein:Password -d @emptyfile.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://example.com/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/IntegrationCloud/instances/ExampleInstance/patches/checks/wls_patch_12.2.1.2.0_170326 

Example of Response Body

The following shows an example 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