Jump to

• Request
• Response

View Job Status of a Patch Application or Rollback Operation

get

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

Returns information about the long-running job to apply or roll back a patch.

Request

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.

• jobId: string
  Unique ID of a patching or rollback operation.
• 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.

Back to Top

Response

Supported Media Types

• application/json

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

• additionalNote(optional): string
  Free-form text to provide additional information about the patch.
• appliedBy(optional): string
  Name of the user that applied the patch. system displays if the patch was applied by an auto-update scheduled job.
• appliedDate(optional): string
  Date and time that the patch was applied.
• backupId(optional): string
  Backup ID. You can use the backup ID to manage the backup.
• backupStatus(optional): string
  Whether a backup of the software was created before the patch was applied. Valid values include: Available, SameVersion, Unavailable, Unknown.
• componentPatches(optional): array componentPatches
  Group the details of each patches in the component.
• currentPatchLevel(optional): string
  Current patch level for the component.
• displayName(optional): string
  Display name of the patch.
• id(optional): integer
  Unique ID of the patching operation. Use this ID to get details of a patching operation.
• inProgress(optional): boolean
  Flag that specifies whether the patch is still in progress.
• jobId(optional): string
  Job ID for the patch operation.
• lastStatus(optional): string
  Status of the patch operation. For example: IN PROGRESS, COMPLETED, and FAILED. COMPLETED_ROLLBACK is displayed when an applied patch has been rolled back.
• lastStatusMessage(optional): string
  Last message logged for the patch operation.
• operationType(optional): string
  Patch operating being performed. Valid values include: Rollback, Patching, and None.
• patchCategory(optional): string
  Category of the patch. For example: General, Multiple, Security, and so on.
• patchComponents(optional): array patchComponents
  Group the details of the patch to be applied.
• patchDescription(optional): string
  Description of the patch.
• patchId(optional): string
  Patch ID.
• patchingResult(optional): object patching-result
  Groups information about the results of the patch.
• patchReleaseUrl(optional): string
  URL that provides more information about the patch.
• patchSeverity(optional): string
  Severity of the patch. For example Normal, Mandatory, Recommended, and so on.
• patchType(optional): string
  Patch type classification. For example, Quarterly, Security.
• progressMessages(optional): array progressMessages
  List of progress messages for the patch.
• releaseDate(optional): string
  Date and time patch was released.
• rollbackId(optional): string
  ID of the rollback that is associated to the completed patching operation. The ID is used to rollback a patch operation.
• rollbackResult(optional): object rollback-result
  Groups information about the results of the rollback operation. This attribute displays only when a rollback of the patch had been performed.
• rollbackVersion(optional): string
  Version to which the patched component will be rolled back.
• totalTime(optional): string
  Duration of the patch operation.
• toVersion(optional): string
  Version of Oracle Database Classic Cloud Service instance that was patched.

{
    "description":"Information about an applied patch.",
    "properties":{
        "backupStatus":{
            "type":"string",
            "description":"Whether a backup of the software was created before the patch was applied. Valid values include: <code>Available</code>, <code>SameVersion</code>, <code>Unavailable</code>, <code>Unknown</code>."
        },
        "additionalNote":{
            "type":"string",
            "description":"Free-form text to provide additional information about the patch."
        },
        "appliedBy":{
            "type":"string",
            "description":"Name of the user that applied the patch. <code>system</code> displays if the patch was applied by an auto-update scheduled job."
        },
        "appliedDate":{
            "type":"string",
            "description":"Date and time that the patch was applied."
        },
        "totalTime":{
            "type":"string",
            "description":"Duration of the patch operation."
        },
        "patchId":{
            "type":"string",
            "description":"Patch ID."
        },
        "patchDescription":{
            "type":"string",
            "description":"Description of the patch."
        },
        "patchReleaseUrl":{
            "type":"string",
            "description":"URL that provides more information about the patch."
        },
        "releaseDate":{
            "type":"string",
            "description":"Date and time patch was released."
        },
        "lastStatus":{
            "type":"string",
            "description":"Status of the patch operation. For example: <code>IN PROGRESS</code>, <code>COMPLETED</code>, and <code>FAILED</code>. <code>COMPLETED_ROLLBACK</code> is displayed when an applied patch has been rolled back."
        },
        "lastStatusMessage":{
            "type":"string",
            "description":"Last message logged for the patch operation."
        },
        "componentPatches":{
            "type":"array",
            "description":"Group the details of each patches in the component.",
            "items":{
                "$ref":"#/definitions/component-patch"
            }
        },
        "patchComponents":{
            "type":"array",
            "description":"Group the details of the patch to be applied.",
            "items":{
                "$ref":"#/definitions/patch-component"
            }
        },
        "patchType":{
            "type":"string",
            "description":"Patch type classification. For example, <code>Quarterly</Code>, <code>Security</Code>."
        },
        "patchCategory":{
            "type":"string",
            "description":"Category of the patch. For example: <code>General</code>, <code>Multiple</code>, <code>Security</code>, and so on."
        },
        "patchSeverity":{
            "type":"string",
            "description":"Severity of the patch. For example <code>Normal</code>, <code>Mandatory</code>, <code>Recommended</code>, and so on."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID for the patch operation."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the patch."
        },
        "toVersion":{
            "type":"string",
            "description":"Version of Oracle Database Classic Cloud Service instance that was patched."
        },
        "backupId":{
            "type":"string",
            "description":"Backup ID. You can use the backup ID to manage the backup."
        },
        "inProgress":{
            "type":"boolean",
            "description":"Flag that specifies whether the patch is still in progress."
        },
        "operationType":{
            "type":"string",
            "description":"Patch operating being performed. Valid values include: <code>Rollback</code>, <code>Patching</code>, and <code>None</code>."
        },
        "id":{
            "type":"integer",
            "description":"Unique ID of the patching operation. Use this ID to get details of a patching operation."
        },
        "patchingResult":{
            "$ref":"#/definitions/patching-result"
        },
        "rollbackResult":{
            "$ref":"#/definitions/rollback-result"
        },
        "rollbackId":{
            "type":"string",
            "description":"ID of the rollback that is associated to the completed patching operation. The ID is used to rollback a patch operation."
        },
        "rollbackVersion":{
            "type":"string",
            "description":"Version to which the patched component will be rolled back."
        },
        "currentPatchLevel":{
            "type":"string",
            "description":"Current patch level for the component."
        },
        "progressMessages":{
            "type":"array",
            "description":"List of progress messages for the patch.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : componentPatches

Type: array

Group the details of each patches in the component.

Show Source

• Array of: object component-patch
  Group the details of each patch in the component.

{
    "type":"array",
    "description":"Group the details of each patches in the component.",
    "items":{
        "$ref":"#/definitions/component-patch"
    }
}

Nested Schema : patchComponents

Type: array

Group the details of the patch to be applied.

Show Source

• Array of: object patch-component
  Group the details of the patch to be applied.

{
    "type":"array",
    "description":"Group the details of the patch to be applied.",
    "items":{
        "$ref":"#/definitions/patch-component"
    }
}

Nested Schema : patching-result

Type: object

Groups information about the results of the patch.

Show Source

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

{
    "type":"object",
    "description":"Groups information about the results of the patch.",
    "properties":{
        "additionalNote":{
            "type":"string",
            "description":"Free-form text to provide additional information about the rollback.",
            "properties":{
                "patchingId":{
                    "type":"integer",
                    "description":"ID of the applied patch operation."
                },
                "backupId":{
                    "type":"string",
                    "description":"Backup ID. You can use the backup ID to manage the backup."
                },
                "versionBeforeThisPatch":{
                    "type":"string",
                    "description":"Version of the component before the patch was applied."
                },
                "strategy":{
                    "type":"string",
                    "description":"Patching strategy. For example, <code>Rolling</code>. To minimize service disruption, the patch is applied in a rolling pattern, patching a single node at a time."
                },
                "metaVersionBeforeThisPatch":{
                    "type":"string",
                    "description":"Version of the metadata service manager before the patch was applied."
                },
                "customRollbackId":{
                    "type":"string",
                    "description":"ID to be used in a rollback operation."
                },
                "startDate":{
                    "type":"string",
                    "description":"Date and time that the patch operation started."
                },
                "endDate":{
                    "type":"string",
                    "description":"Date the patch operation ended."
                },
                "patchingStatus":{
                    "type":"string",
                    "description":"Status of the patching operation. For example, <code>COMPLETED</code>. <code>COMPLETED_ROLLBACK</code> is displayed when an applied patch has been rolled back."
                },
                "resultMessage":{
                    "type":"string",
                    "description":"System message that describes the patching operation."
                },
                "additionalNote":{
                    "type":"string",
                    "description":"Free-form text to provide additional information about the patch."
                },
                "appliedBy":{
                    "type":"string",
                    "description":"Name of the user that applied the patch. <code>system</code> displays if the patch was applied by an auto-update scheduled job."
                },
                "jobId":{
                    "type":"string",
                    "description":"Job ID for the patch operation."
                },
                "completeLog":{
                    "type":"string",
                    "description":"System messages that track the patch operations."
                },
                "progressMessages":{
                    "type":"array",
                    "description":"List of progress messages for the patch.",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : progressMessages

Type: array

List of progress messages for the patch.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of progress messages for the patch.",
    "items":{
        "type":"string"
    }
}

Nested Schema : rollback-result

Type: object

Groups information about the results of the rollback operation. This attribute displays only when a rollback of the patch had been performed.

Show Source

• additionalNote(optional): string
  Free-form text to provide additional information about the rollback.
• appliedBy(optional): string
  Name of the user that performed the rollback.
• completeLog(optional): string
  System messages that track the rollback operations.
• endDate(optional): string
  Date the rollback operation ended.
• jobId(optional): string
  Job ID for the rollback operation.
• patchingStatus(optional): string
  Status of the rollback operation. For example, COMPLETED_ROLLBACK.
• progressMessages(optional): array progressMessages
  List of progress messages for the rollback.
• resultMessage(optional): string
  System message that describes the rollback operation.
• rollbackId(optional): integer
  ID of the rollback operation.
• startDate(optional): string
  Date and time that the rollback operation started.

{
    "type":"object",
    "description":"Groups information about the results of the rollback operation. This attribute displays only when a rollback of the patch had been performed.",
    "properties":{
        "rollbackId":{
            "type":"integer",
            "description":"ID of the rollback operation."
        },
        "startDate":{
            "type":"string",
            "description":"Date and time that the rollback operation started."
        },
        "endDate":{
            "type":"string",
            "description":"Date the rollback operation ended."
        },
        "patchingStatus":{
            "type":"string",
            "description":"Status of the rollback operation. For example, <code>COMPLETED_ROLLBACK</code>."
        },
        "resultMessage":{
            "type":"string",
            "description":"System message that describes the rollback operation."
        },
        "additionalNote":{
            "type":"string",
            "description":"Free-form text to provide additional information about the rollback."
        },
        "appliedBy":{
            "type":"string",
            "description":"Name of the user that performed the rollback."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID for the rollback operation."
        },
        "completeLog":{
            "type":"string",
            "description":"System messages that track the rollback operations."
        },
        "progressMessages":{
            "type":"array",
            "description":"List of progress messages for the rollback.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : component-patch

Type: object

Group the details of each patch in the component.

Show Source

• description(optional): string
  Brief description of the patch.
• displayName(optional): string
  Display name of the component in this patch.
• id(optional): integer
  ID of a component patch.
• preserveFiles(optional): array preserveFiles
  List of files to be preserved during patching.
• releaseVersion(optional): string
  Release version of the component in this patch.
• version(optional): string
  Version of the patch component.
• zipBundles(optional): array zipBundles
  Zips that contain the patched binaries or patches.

{
    "description":"Group the details of each patch in the component.",
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID of a component patch."
        },
        "version":{
            "type":"string",
            "description":"Version of the patch component."
        },
        "releaseVersion":{
            "type":"string",
            "description":"Release version of the component in this patch."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the component in this patch."
        },
        "description":{
            "type":"string",
            "description":"Brief description of the patch."
        },
        "zipBundles":{
            "type":"array",
            "description":"Zips that contain the patched binaries or patches.",
            "items":{
                "$ref":"#/definitions/view-zip-bundles"
            }
        },
        "preserveFiles":{
            "type":"array",
            "description":"List of files to be preserved during patching.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : preserveFiles

Type: array

List of files to be preserved during patching.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of files to be preserved during patching.",
    "items":{
        "type":"string"
    }
}

Nested Schema : zipBundles

Type: array

Zips that contain the patched binaries or patches.

Show Source

• Array of: object view-zip-bundles
  Group the details of zips for the patched binaries.

{
    "type":"array",
    "description":"Zips that contain the patched binaries or patches.",
    "items":{
        "$ref":"#/definitions/view-zip-bundles"
    }
}

Nested Schema : view-zip-bundles

Type: object

Group the details of zips for the patched binaries.

Show Source

• displayName(optional): string
  Display name of this component.
• id(optional): integer
  ID of a component patch.
• md5sum(optional): string
  Checksum used to validate the patch binary.
• provisioningObjectRef(optional): string
  Location of binary to use when creating a new service instance.
• releaseDate(optional): string
  Release date of this version.
• releaseUrl(optional): string
  URL for more information about this release.
• storageKey(optional): string
  Location of the patch zip on the cloud.
• zipVersion(optional): string
  Software version that is included in the zip.

{
    "description":"Group the details of zips for the patched binaries.",
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID of a component patch."
        },
        "md5sum":{
            "type":"string",
            "description":"Checksum used to validate the patch binary."
        },
        "provisioningObjectRef":{
            "type":"string",
            "description":"Location of binary to use when creating a new service instance."
        },
        "storageKey":{
            "type":"string",
            "description":"Location of the patch zip on the cloud."
        },
        "zipVersion":{
            "type":"string",
            "description":"Software version that is included in the zip."
        },
        "releaseDate":{
            "type":"string",
            "description":"Release date of this version."
        },
        "releaseUrl":{
            "type":"string",
            "description":"URL for more information about this release."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of this component."
        }
    }
}

Nested Schema : patch-component

Type: object

Group the details of the patch to be applied.

Show Source

• component(optional): string
  Name of the component in this patch db.
• id(optional): integer
  ID of a component patch.
• md5sum(optional): string
  Checksum used to validate the patch binary.
• patchingObjectRef(optional): string
  Location of binary to use when patching a service instance.
• preserveFiles(optional): array preserveFiles
  List of files to be preserved during patching.
• provisioningObjectRef(optional): string
  Location of binary to use when creating a new service instance.
• version(optional): string
  Version of the patch component.

{
    "description":"Group the details of the patch to be applied.",
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID of a component patch."
        },
        "component":{
            "type":"string",
            "description":"Name of the component in this patch <code>db</code>."
        },
        "version":{
            "type":"string",
            "description":"Version of the patch component."
        },
        "md5sum":{
            "type":"string",
            "description":"Checksum used to validate the patch binary."
        },
        "provisioningObjectRef":{
            "type":"string",
            "description":"Location of binary to use when creating a new service instance."
        },
        "patchingObjectRef":{
            "type":"string",
            "description":"Location of binary to use when patching a service instance."
        },
        "preserveFiles":{
            "type":"array",
            "description":"List of files to be preserved during patching.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : preserveFiles

Type: array

List of files to be preserved during patching.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of files to be preserved during patching.",
    "items":{
        "type":"string"
    }
}

Nested Schema : progressMessages

Type: array

List of progress messages for the patch.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of progress messages for the patch.",
    "items":{
        "type":"string"
    }
}

Nested Schema : progressMessages

Type: array

List of progress messages for the rollback.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of progress messages for the rollback.",
    "items":{
        "type":"string"
    }
}

Back to Top