1. REST API for Oracle Database Exadata Cloud Service (OCI-C)
  2. Tasks
  3. Manage Patching

View a Patch Operation

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/applied/job/{jobId}

Returns information about the specified patching operation for an Exadata Cloud Service database deployment.

Request

Path Parameters

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

  • Unique ID of a patching or rollback operation.
  • Name of the Exadata Cloud Service deployment.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : applied-patch
Type: object
Information about an applied patch.
Show Source
Nested Schema : componentPatches
Type: array
Group the details of each patches in the component.
Show Source
Nested Schema : patchComponents
Type: array
Group the details of the patch to be applied.
Show Source
Nested Schema : patching-result
Type: object
Information about the results of the patch.
Show Source
Nested Schema : progressMessages
Type: array
List of progress messages for the patch.
Show Source
Nested Schema : rollback-result
Type: object
Information about the results of the rollback operation, which displays only when a rollback of the patch had been performed.
Show Source
Nested Schema : component-patch
Type: object
Group the details of each patch in the component.
Show Source
Nested Schema : preserveFiles
Type: array
List of files to be preserved during patching.
Show Source
Nested Schema : zipBundles
Type: array
Zips that contain the patched binaries or patches.
Show Source
Nested Schema : view-zip-bundles
Type: object
Group the details of zips for the patched binaries.
Show Source
Nested Schema : patch-component
Type: object
Group the details of the patch to be applied.
Show Source
Nested Schema : preserveFiles
Type: array
List of files to be preserved during patching.
Show Source
Nested Schema : progressMessages
Type: array
List of progress messages for the patch.
Show Source
Nested Schema : progressMessages
Type: array
List of progress messages for the rollback.
Show Source
Back to Top

Examples

The following example shows how to view information about the status of a specific patch (or rollback) operation associated with an Exadata Cloud Service database deployment by submitting a GET request on the REST endpoint using cURL.

In this example, the identity domain is usexample, the Exadata Cloud Service database deployment is db12c and the Oracle Cloud user name and password are serviceadmin and Pa55_word. Also, in the example the operation being performed is a rollback of a previously applied patch, and the job identification number for the rollback operation is 12224035.

cURL Command

curl -i -X GET --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample"  https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db12c/patches/applied/job/12224035

HTTP Status Code and Response Headers

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

Response Body

[{
		"backupStatus": "Available",
		"additionalNote": "Patch rolled back using REST API",
		"appliedBy": "serviceadmin",
		"appliedDate": "2017-05-30T01:37:39.260+0000",
		"totalTime": "0 min, 0 sec",
		"patchId": "24968615",
		"patchDescription": "DB 12.1.0.2.170117 QUARTERLY DATABASE PATCH FOR EXADATA - JAN2017",
		"patchReleaseUrl": "https://support.oracle.com/epmos/faces/PatchDetail?patchId\u003d24968615",
		"releaseDate": "2017-01-17T01:40:00.000+0000",
		"lastStatus": "IN_PROGRESS",
		"lastStatusMessage": "Rollback in progress",
		"componentPatches": {
			"EXADATA": {
				"id": 2651,
				"version": "12.1.0.2.170117",
				"releaseVersion": "12.1.0.2.170117",
				"zipBundles": {
					"EXADATA": {
						"id": 4721,
						"md5sum": "48a8623500c7f4b50e703011a1cfeb67",
						"storageKey": "PATCH/DB/12c/database.zip",
						"zipVersion": "12.1.0.2.170117"
					}
				},
				"preserveFiles": []
			}
		},
		"patchType": "PSU",
		"patchCategory": "DB",
		"patchSeverity": "Normal",
		"jobId": "12224035",
		"displayName": "12.1.0.2.170117",
		"inProgress": true,
		"operationType": "Rollback",
		"id": 505609,
		"patchingResult": {
			"patchingId": 455908,
			"versionBeforeThisPatch": "EXADATA 12.1.0.2.161018",
			"strategy": "Rolling",
			"releaseVersionBeforeThisPatch": "12.1.0.2",
			"customRollbackId": "12223582_1496102613534",
			"startDate": "2017-05-30T00:03:33.534+0000",
			"endDate": "2017-05-30T01:10:46.198+0000",
			"patchingStatus": "COMPLETED",
			"additionalNote": "Patch applied using REST API",
			"appliedBy": "serviceadmin",
			"jobId": "12223582",
			"completeLog": "",
			"progressMessages": ["12:03:33.398 AM Phase initialize started", "12:03:33.620 AM Phase initialize completed", "12:03:33.715 AM Phase patch started", "1:10:45.678 AM Phase patch completed", "1:10:45.877 AM Phase finalize started", "1:10:45.963 AM Completed"]
		},
		"rollbackResult": {
			"rollbackId": 1101,
			"startDate": "2017-05-30T01:37:39.260+0000",
			"endDate": "2017-05-30T01:37:39.395+0000",
			"patchingStatus": "IN_PROGRESS",
			"additionalNote": "Patch rolled back using REST API",
			"appliedBy": "serviceadmin",
			"jobId": "12224035",
			"completeLog": "",
			"progressMessages": ["1:37:39.236 AM Phase initialize started", "1:37:39.321 AM Phase initialize completed", "1:37:39.383 AM Phase rollback started"]
		},
		"rollbackId": "505609",
		"rollbackVersion": "12.1.0.2",
		"currentPatchLevel": "12.1.0.2"
	}
]
Back to Top