db_system_upgrade_history_entries

Creates, updates, deletes, gets or lists a db_system_upgrade_history_entries resource.

Overview

Name	db_system_upgrade_history_entries
Type	Resource
Id	oci.database.db_system_upgrade_history_entries

Fields

The following fields are returned by SELECT queries:

get

The upgrade operation details were retrieved.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the upgrade history entry.
action	string	The operating system upgrade action. (PRECHECK, ROLLBACK, UPDATE_SNAPSHOT_RETENTION_DAYS, UPGRADE)
lifecycleDetails	string	A descriptive text associated with the lifecycleState. Typically contains additional displayable text.
lifecycleState	string	The current state of the action. (IN_PROGRESS, SUCCEEDED, FAILED, NEEDS_ATTENTION)
newGiVersion	string	A valid Oracle Grid Infrastructure (GI) software version.
newOsVersion	string	A valid Oracle Software (OS) version eg. Oracle Linux Server release 8
oldGiVersion	string	A valid Oracle Grid Infrastructure (GI) software version.
oldOsVersion	string	A valid Oracle Software (OS) version eg. Oracle Linux Server release 8
snapshotRetentionPeriodInDays	integer	The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.
timeEnded	string (date-time)	The date and time when the upgrade action completed
timeStarted	string (date-time)	The date and time when the upgrade action started.

list

The summary for the record of an OS upgrade action on a DB system.<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the upgrade history entry.
action	string	The operating system upgrade action. (PRECHECK, ROLLBACK, UPDATE_SNAPSHOT_RETENTION_DAYS, UPGRADE)
lifecycleDetails	string	A descriptive text associated with the lifecycleState. Typically contains additional displayable text.
lifecycleState	string	The current state of the action. (IN_PROGRESS, SUCCEEDED, FAILED, NEEDS_ATTENTION)
newGiVersion	string	A valid Oracle Grid Infrastructure (GI) software version.
newOsVersion	string	A valid Oracle Software (OS) version eg. Oracle Linux Server release 8
oldGiVersion	string	A valid Oracle Grid Infrastructure (GI) software version.
oldOsVersion	string	A valid Oracle Software (OS) version eg. Oracle Linux Server release 8
snapshotRetentionPeriodInDays	integer	The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.
timeEnded	string (date-time)	The date and time when the upgrade action completed
timeStarted	string (date-time)	The date and time when the upgrade action started.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	dbSystemId, upgradeHistoryEntryId, region	opc-request-id	Gets the details of the specified operating system upgrade operation for the specified DB system.<br />
list	select	dbSystemId, region	limit, page, sortOrder, sortBy, upgradeAction, lifecycleState, opc-request-id	Gets the history of the upgrade actions performed on the specified DB system.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dbSystemId	string	The DB system [OCID](/Content/General/Concepts/identifiers.htm).
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
upgradeHistoryEntryId	string	The database/db system upgrade History [OCID](/Content/General/Concepts/identifiers.htm).
lifecycleState	string	A filter to return only upgrade history entries that match the given lifecycle state exactly.
limit	integer	The maximum number of items to return per page.
opc-request-id	string	Unique identifier for the request.
page	string	The pagination token to continue listing from.
sortBy	string	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is ascending.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC).
upgradeAction	string	A filter to return only upgradeHistoryEntries that match the specified Upgrade Action.

SELECT examples

get

Gets the details of the specified operating system upgrade operation for the specified DB system.<br />

SELECT
id,
action,
lifecycleDetails,
lifecycleState,
newGiVersion,
newOsVersion,
oldGiVersion,
oldOsVersion,
snapshotRetentionPeriodInDays,
timeEnded,
timeStarted
FROM oci.database.db_system_upgrade_history_entries
WHERE dbSystemId = '{{ dbSystemId }}' -- required
AND upgradeHistoryEntryId = '{{ upgradeHistoryEntryId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Gets the history of the upgrade actions performed on the specified DB system.<br />

SELECT
id,
action,
lifecycleDetails,
lifecycleState,
newGiVersion,
newOsVersion,
oldGiVersion,
oldOsVersion,
snapshotRetentionPeriodInDays,
timeEnded,
timeStarted
FROM oci.database.db_system_upgrade_history_entries
WHERE dbSystemId = '{{ dbSystemId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortOrder = '{{ sortOrder }}'
AND sortBy = '{{ sortBy }}'
AND upgradeAction = '{{ upgradeAction }}'
AND lifecycleState = '{{ lifecycleState }}'
AND opc-request-id = '{{ opc-request-id }}'
;