Jump to

• Request
• Response
• Examples

Rollback a Patch

put

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

Rolls back a patch for an Exadata Cloud Service database deployment.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string

  The value depends on the type of Exadata Cloud Service account that is used to make the request:

  • For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.

  • For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.

• rollbackId: string
  ID of the rollback that is associated to the completed patching operation.
• serviceId: string
  Name of the Exadata Cloud Service deployment.

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

  The value depends on the type of Exadata Cloud Service account that is used to make the request:

  • For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.

  • For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.

  For more information, see Security, Authentication and Authorization.

Body ()

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

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

  Specifies whether a Data Guard switchover operation is performed on the primary database before rolling back the patch. Valid values are true and false.

  Default value is false.

  (Applicable only to deployments associated with a Data Guard configuration.)

{
    "title":"Request Body",
    "type":"object",
    "description":"",
    "properties":{
        "additionalNote":{
            "type":"string",
            "description":"Free-form text to provide additional information about the rollback operation."
        },
        "switchOver":{
            "type":"boolean",
            "description":"<p>Specifies whether a Data Guard switchover operation is performed on the primary database before rolling back the patch. Valid values are <code>true</code> and <code>false</code>.</p><p>Default value is <code>false</code>.</p><p>(Applicable only to deployments associated with a Data Guard configuration.)</p>"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

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

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 roll back a patch on an Exadata Cloud Service database deployment by submitting a PUT request on the REST endpoint using cURL.

In this example, the identity domain is usexample and the Oracle Cloud user name and password are serviceadmin and Pa55_word. The name of the database deployment is db12c and the rollback identification number is 505609.

cURL Command

In the following cURL command, the request body is provided directly in the -d option.

curl -i -X PUT --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample" -H "Content-Type:application/json" -d '{ "additionalNote" : "Patch rolled back using REST API" }' https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db12c/patches/505609/rollback

HTTP Status Code and Response Headers

HTTP/2.0 202
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
location: https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/DBaaS/instances/db12c/patches/applied/job/12224035
content-language: en
access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
retry-after: 60
access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
x-oracle-dms-ecid: 005KBFPKCHP6uHFpR05Eid0007dd0002fU
x-oracle-dms-ecid: 005KBFPKCHP6uHFpR05Eid0007dd0002fU
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Tue, 30 May 2017 01:37:39 GMT

Response Body

{
	"status": "Completed",
	"details": {
		"message": "PATCHING-5038: Rollback of service from patch [24968615] is submitted as an asynchronous job.",
		"jobId": "12224035"
	}
}

Back to Top