Skip to main content

dbnode_snapshots

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

Overview​

Namedbnode_snapshots
TypeResource
Idoci.database.dbnode_snapshots

Fields​

The following fields are returned by SELECT queries:

Information about the Exadata Database Node Snapshot.

NameDatatypeDescription
idstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node Snapshot.
namestringThe user-friendly name for the Database Node Snapshot. The name should be unique.
clusterIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster.
compartmentIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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).
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 of the Exadata Database Node Snapshot.
lifecycleStatestringThe current state of the Exadata Database Node Snapshot. (CREATING, AVAILABLE, TERMINATING, TERMINATED, FAILED, MOUNTED, MOUNTING, UNMOUNTING)
mountPointsarrayDetails of the mount points
sourceDbnodeIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node.
systemTagsobjectSystem tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreatedstring (date-time)The date and time that the Exadata Database Node Snapshot was created.
volumesarrayDetails of the volumes

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdbnodeSnapshotId, regionopc-request-idGets information about the specified Exadata Database Node Snapshot in the specified compartment.<br />
listselectcompartmentId, regionlimit, page, sortBy, name, sortOrder, lifecycleState, clusterId, sourceDbnodeId, opc-request-idGets a list of the Exadata Database Node Snapshots in the specified compartment.<br />
deletedeletedbnodeSnapshotId, regionif-match, opc-request-idDeletes the specified Exadata Database Node Snapshot.<br />
mount_dbnode_snapshotexecdbnodeSnapshotId, region, dbNodeIdopc-retry-token, opc-request-id, if-matchMounts the snapshot for the provided dbNode.<br />
unmount_dbnode_snapshotexecdbnodeSnapshotId, region, dbNodeIdopc-retry-token, opc-request-id, if-matchUnmounts the snapshot for the provided dbNode.<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
compartmentIdstringThe compartment [OCID](/Content/General/Concepts/identifiers.htm).
dbnodeSnapshotIdstringThe Exadata Database Node Snapshot [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)
clusterIdstringA filter to return only Exadata Database Node Snapshots that match the given VM cluster.
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 Exadata Database Snapshots that match the given lifecycle state exactly.
limitintegerThe maximum number of items to return per page.
namestringA filter to return only resources that match the entire name given. The match is not case sensitive.
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 NAME is ascending. The NAME sort order is case sensitive.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC).
sourceDbnodeIdstringA filter to return only Exadata Database Snapshots that match the given database node.

SELECT examples​

Gets information about the specified Exadata Database Node Snapshot in the specified compartment.<br />

SELECT
id,
name,
clusterId,
compartmentId,
definedTags,
freeformTags,
lifecycleDetails,
lifecycleState,
mountPoints,
sourceDbnodeId,
systemTags,
timeCreated,
volumes
FROM oci.database.dbnode_snapshots
WHERE dbnodeSnapshotId = '{{ dbnodeSnapshotId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

DELETE examples​

Deletes the specified Exadata Database Node Snapshot.<br />

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

Lifecycle Methods​

Mounts the snapshot for the provided dbNode.<br />

EXEC oci.database.dbnode_snapshots.mount_dbnode_snapshot 
@dbnodeSnapshotId='{{ dbnodeSnapshotId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"dbNodeId": "{{ dbNodeId }}"
}'
;