Skip to main content

vm_cluster_update_history_entries

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

Overview​

Namevm_cluster_update_history_entries
TypeResource
Idoci.database.vm_cluster_update_history_entries

Fields​

The following fields are returned by SELECT queries:

The maintenance update history details for the specified update history entry.

NameDatatypeDescription
idstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry.
lifecycleDetailsstringDescriptive text providing additional details about the lifecycle state.
lifecycleStatestringThe current lifecycle state of the maintenance update operation. (IN_PROGRESS, SUCCEEDED, FAILED)
timeCompletedstring (date-time)The date and time when the maintenance update action completed.
timeStartedstring (date-time)The date and time when the maintenance update action started.
updateActionstringThe update action performed using this maintenance update. (ROLLING_APPLY, PRECHECK, ROLLBACK)
updateIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update.
updateTypestringThe type of VM cluster maintenance update. (GI_UPGRADE, GI_PATCH, OS_UPDATE)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectvmClusterId, updateHistoryEntryId, regionopc-request-idGets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud@Customer instances only.<br />
listselectvmClusterId, regionupdateType, lifecycleState, limit, page, opc-request-idGets the history of the maintenance update actions performed on the specified VM cluster. Applies to Exadata Cloud@Customer instances only.<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.

NameDatatypeDescription
regionstringOCI 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)
updateHistoryEntryIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry.
vmClusterIdstringThe VM cluster [OCID](/Content/General/Concepts/identifiers.htm).
lifecycleStatestringA filter to return only resources that match the given lifecycle state exactly.
limitintegerThe maximum number of items to return per page.
opc-request-idstringUnique identifier for the request.
pagestringThe pagination token to continue listing from.
updateTypestringA filter to return only resources that match the given update type exactly.

SELECT examples​

Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud@Customer instances only.<br />

SELECT
id,
lifecycleDetails,
lifecycleState,
timeCompleted,
timeStarted,
updateAction,
updateId,
updateType
FROM oci.database.vm_cluster_update_history_entries
WHERE vmClusterId = '{{ vmClusterId }}' -- required
AND updateHistoryEntryId = '{{ updateHistoryEntryId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;