REST API for Oracle Database Classic Cloud Service

Apply a Patch

put

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

Applies a patch to a Database Classic Cloud Service instance.

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

Patch ID of the patch to apply.
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.

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

additionalNote(optional): string

Free-form text to provide additional information about the patching operation.
forceApply(optional): boolean

Specifies whether the patch should be applied even if precheck finds conflicts. When true, patch conflicts or errors discovered during the precheck stage of the patching operation are ignored and the patch will be applied (space permitting). Otherwise, if conflicts or errors are discovered, the patch will not be applied.
Default value is false.
switchOver(optional): boolean

(Applicable only to service instances hosting a Data Guard configuration.)
Specifies whether a switchover operation is performed on the primary database before applying a patch. Valid values are true and false.
Default value is false.

{
    "title":"Request Body",
    "type":"object",
    "description":"",
    "properties":{
        "additionalNote":{
            "type":"string",
            "description":"Free-form text to provide additional information about the patching operation."
        },
        "forceApply":{
            "type":"boolean",
            "description":"Specifies whether the patch should be applied even if precheck finds conflicts. When <code>true</code>, patch conflicts or errors discovered during the precheck stage of the patching operation are ignored and the patch will be applied (space permitting). Otherwise, if conflicts or errors are discovered, the patch will not be applied.<p>Default value is <code>false</code>.</p>"
        },
        "switchOver":{
            "type":"boolean",
            "description":"(Applicable only to service instances hosting a Data Guard configuration.)<p>Specifies whether a switchover operation is performed on the primary database before applying a patch. Valid values are <code>true</code> and <code>false</code>.</p><p>Default value is <code>false</code>.</p>"
        }
    }
}

Response

Supported Media Types

application/json

202 Response

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

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."
        }
    }
}

Examples

The following example shows how to apply 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. Patch 24006101-EE is being applied to 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 patching operation.

cURL Command

curl --include --request PUT \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:mydomain" \
--header "content-type: application/json" \
--data '{"additionalNote": "Applying Oct 2016 PSU"}' \
https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/mydomain/services/dbaas/instances/db121-ep-si/patches/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/applied/job/3375102
Content-Language: en
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Retry-After: 60
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-5068: Patching service with patch [24006101-EE] is submitted as an asynchronous job.",
    "jobId": "3375102"
  }
}