Jump to

• Request
• Response
• Examples

Precheck Application of a Patch

put

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

Performs a precheck to identity potential issues that might prevent the specified patch from being successfully applied to the service instance; it does not actually apply the patch. Specifically, the patching precheck reports on the following conditions:

• Disk space shortage
• Database connectivity failure
• Compute-node access failure
• Storage access failure
• Conflicts with other applied patches

Prechecks do not check whether another administration task that would prevent patching is in progress; for example: backup, recovery, or scaling.

Request

Supported Media Types

• application/json

Path Parameters

• 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.

• patchId: string
  ID of the patch to precheck.
• serviceId: string
  Name of the Database Classic Cloud Service instance.

Header Parameters

• 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.

Body ()

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• additionalNote(optional): string
  Free-form text to provide additional information about the precheck operation.

{
    "title":"Request Body",
    "type":"object",
    "description":"",
    "properties":{
        "additionalNote":{
            "type":"string",
            "description":"Free-form text to provide additional information about the precheck operation."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

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

The Location header returns a REST URI that can be used to access the status of the patching precheck operation.

Body ()

Root Schema : Response Body

Type: object

Title: Response Body

Show Source

• details(optional): object details Object
  Title: details Object
• status(optional): string
  Status of the request to start a job for the operation. Usually the value Completed.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request to start a job for the operation. Usually the value <code>Completed</code>."
        },
        "details":{
            "$ref":"#/definitions/put-response-details-object"
        }
    }
}

Nested Schema : details Object

Type: object

Title: details Object

Show Source

• jobId(optional): string
  Job ID of the job that was started to perform the operation.
• message(optional): string
  Message describing the operation.

{
    "title":"details Object",
    "type":"object",
    "description":"",
    "properties":{
        "message":{
            "type":"string",
            "description":"Message describing the operation."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID of the job that was started to perform the operation."
        }
    }
}

Back to Top

Examples

The following example shows how to precheck application of a patch by submitting a PUT 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 Oracle Cloud user name of the user making the call is dbcsadmin. A precheck of patch 24006101-EE is being performed on the service instance db121-ep-si. Also, note that the Location response header provides a URI you get do a GET request on to track the progress of the precheck operation.

cURL Command

curl --include --request PUT \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:mydomain" \
--header "content-type: application/json" \
--data '{"additionalNote": "Prechecking Oct 2016 PSU"}' \
https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/mydomain/services/dbaas/instances/db121-ep-si/patches/checks/24006101-EE

HTTP Status Code and Response Headers

HTTP/1.0 200 Connection established

HTTP/1.1 202 Accepted
Server: Oracle-Application-Server-11g
Location: https://dbaas.oraclecloud.com:443/paas/api/v1.1/instancemgmt/mydomain/services/DBaaS/instances/db121-ep-si/patches/checks/job/3371498
Content-Language: en
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Retry-After: 10
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
Connection: close

Response Body

{
  "status": "Completed",
  "details": {
    "message": "PATCHING-5227: Pre-Checking service for patch [24006101-EE] is submitted as an asynchronous job.",
    "jobId": "3371498"
  }
}

Back to Top