Skip to main content

console_histories

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

Overview​

Nameconsole_histories
TypeResource
Idoci.database.console_histories

Fields​

The following fields are returned by SELECT queries:

The console history information was retrieved.

NameDatatypeDescription
idstringThe OCID of the console history.
compartmentIdstringThe OCID of the compartment containing the console history.
dbNodeIdstringThe OCID of the database node.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
displayNamestringThe user-friendly name for the console history. The name does not need to be unique.
freeformTagsobjectFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleDetailsstringAdditional information about the current lifecycle state.
lifecycleStatestringThe current state of the console history. (REQUESTED, GETTING_HISTORY, SUCCEEDED, FAILED, DELETED, DELETING)
timeCreatedstring (date-time)The date and time the console history was created.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdbNodeId, consoleHistoryId, regionopc-request-idGets information about the specified database node console history.<br />
listselectdbNodeId, regionlimit, page, opc-request-id, sortBy, sortOrder, lifecycleState, displayNameLists the console histories for the specified database node.<br />
createinsertdbNodeId, region, displayNameopc-retry-token, opc-request-idCaptures the most recent serial console data (up to a megabyte) for the specified database node.<br />
updateupdatedbNodeId, consoleHistoryId, regionif-match, opc-request-idUpdates the specified database node console history.<br />
deletedeletedbNodeId, consoleHistoryId, regionif-match, opc-request-idDeletes the specified database node console history.<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
consoleHistoryIdstringThe OCID of the console history.
dbNodeIdstringThe database node [OCID](/Content/General/Concepts/identifiers.htm).
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)
displayNamestringA filter to return only resources that match the entire display name given. The match is not case sensitive.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
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.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringThe pagination token to continue listing from.
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples​

Gets information about the specified database node console history.<br />

SELECT
id,
compartmentId,
dbNodeId,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
timeCreated
FROM oci.database.console_histories
WHERE dbNodeId = '{{ dbNodeId }}' -- required
AND consoleHistoryId = '{{ consoleHistoryId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Captures the most recent serial console data (up to a megabyte) for the specified database node.<br />

INSERT INTO oci.database.console_histories (
definedTags,
displayName,
freeformTags,
dbNodeId,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ freeformTags }}',
'{{ dbNodeId }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
compartmentId,
dbNodeId,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
timeCreated
;

UPDATE examples​

Updates the specified database node console history.<br />

UPDATE oci.database.console_histories
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
dbNodeId = '{{ dbNodeId }}' --required
AND consoleHistoryId = '{{ consoleHistoryId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
compartmentId,
dbNodeId,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
timeCreated;

DELETE examples​

Deletes the specified database node console history.<br />

DELETE FROM oci.database.console_histories
WHERE dbNodeId = '{{ dbNodeId }}' --required
AND consoleHistoryId = '{{ consoleHistoryId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;