volume_group_backups

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

Overview

Name	volume_group_backups
Type	Resource
Id	oci.block_storage.volume_group_backups

Fields

The following fields are returned by SELECT queries:

get

The volume group backup was retrieved.

Name	Datatype	Description
id	string	The OCID of the volume group backup.
compartmentId	string	The OCID of the compartment that contains the volume group backup.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
expirationTime	string (date-time)	The date and time the volume group backup will expire and be automatically deleted. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
freeformTags	object	Free-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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleState	string	The current state of a volume group backup. (CREATING, COMMITTED, AVAILABLE, TERMINATING, TERMINATED, FAULTY, REQUEST_RECEIVED)
sizeInGBs	integer (int64)	The aggregate size of the volume group backup, in GBs.
sizeInMBs	integer (int64)	The aggregate size of the volume group backup, in MBs.
sourceType	string	Specifies whether the volume group backup was created manually, or via scheduled backup policy. (MANUAL, SCHEDULED)
sourceVolumeGroupBackupId	string	The OCID of the source volume group backup.
timeCreated	string (date-time)	The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
timeRequestReceived	string (date-time)	The date and time the request to create the volume group backup was received. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
type	string	The type of backup. (FULL, INCREMENTAL)
uniqueSizeInGbs	integer (int64)	The aggregate size used by the volume group backup, in GBs. It is typically smaller than sizeInGBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs	integer (int64)	The aggregate size used by the volume group backup, in MBs. It is typically smaller than sizeInMBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds	array	OCIDs for the volume backups in this volume group backup.
volumeGroupId	string	The OCID of the source volume group.

list

A point-in-time copy of a volume group that can then be used to create a new volume group<br />or restore a volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).<br /><br />To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,<br />talk to an administrator. If you're an administrator who needs to write policies to give users access, see<br />[Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).<br /><br />Warning: Oracle recommends that you avoid using any confidential information when you<br />supply string values using the API.<br />

Name	Datatype	Description
id	string	The OCID of the volume group backup.
compartmentId	string	The OCID of the compartment that contains the volume group backup.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
expirationTime	string (date-time)	The date and time the volume group backup will expire and be automatically deleted. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
freeformTags	object	Free-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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleState	string	The current state of a volume group backup. (CREATING, COMMITTED, AVAILABLE, TERMINATING, TERMINATED, FAULTY, REQUEST_RECEIVED)
sizeInGBs	integer (int64)	The aggregate size of the volume group backup, in GBs.
sizeInMBs	integer (int64)	The aggregate size of the volume group backup, in MBs.
sourceType	string	Specifies whether the volume group backup was created manually, or via scheduled backup policy. (MANUAL, SCHEDULED)
sourceVolumeGroupBackupId	string	The OCID of the source volume group backup.
timeCreated	string (date-time)	The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
timeRequestReceived	string (date-time)	The date and time the request to create the volume group backup was received. Format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339).
type	string	The type of backup. (FULL, INCREMENTAL)
uniqueSizeInGbs	integer (int64)	The aggregate size used by the volume group backup, in GBs. It is typically smaller than sizeInGBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs	integer (int64)	The aggregate size used by the volume group backup, in MBs. It is typically smaller than sizeInMBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds	array	OCIDs for the volume backups in this volume group backup.
volumeGroupId	string	The OCID of the source volume group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	volumeGroupBackupId, region		Gets information for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).
list	select	compartmentId, region	volumeGroupId, limit, page, displayName, sortBy, sortOrder	Lists the volume group backups in the specified compartment. You can filter the results by volume group.<br />For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).<br />
create	insert	region, volumeGroupId	opc-retry-token	Creates a new backup volume group of the specified volume group.<br />For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).<br />
update	update	volumeGroupBackupId, region	if-match	Updates the display name for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).
delete	delete	volumeGroupBackupId, region	if-match	Deletes a volume group backup. This operation deletes all the backups in<br />the volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).<br />
change_compartment	exec	volumeGroupBackupId, region, compartmentId	opc-request-id	Moves a volume group backup into a different compartment within the same tenancy.<br />For information about moving resources between compartments,<br />see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />
copy_volume_group_backup	exec	volumeGroupBackupId, region, destinationRegion	opc-retry-token, opc-request-id	Creates a volume group backup copy in specified region. For general information about volume group backups,<br />see [Overview of Block Volume Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm).<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
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
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)
volumeGroupBackupId	string	The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.
displayName	string	A filter to return only resources that match the given display name exactly.
if-match	string	For 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.
limit	integer	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-request-id	string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-token	string	A 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).
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBy	string	The 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. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.
volumeGroupId	string	The OCID of the volume group.

SELECT examples

get

Gets information for the specified volume group backup. For more information, see Volume Groups.

SELECT
id,
compartmentId,
definedTags,
displayName,
expirationTime,
freeformTags,
lifecycleState,
sizeInGBs,
sizeInMBs,
sourceType,
sourceVolumeGroupBackupId,
timeCreated,
timeRequestReceived,
type,
uniqueSizeInGbs,
uniqueSizeInMbs,
volumeBackupIds,
volumeGroupId
FROM oci.block_storage.volume_group_backups
WHERE volumeGroupBackupId = '{{ volumeGroupBackupId }}' -- required
AND region = '{{ region }}' -- required
;

list

Lists the volume group backups in the specified compartment. You can filter the results by volume group.<br />For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).<br />

SELECT
id,
compartmentId,
definedTags,
displayName,
expirationTime,
freeformTags,
lifecycleState,
sizeInGBs,
sizeInMBs,
sourceType,
sourceVolumeGroupBackupId,
timeCreated,
timeRequestReceived,
type,
uniqueSizeInGbs,
uniqueSizeInMbs,
volumeBackupIds,
volumeGroupId
FROM oci.block_storage.volume_group_backups
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND volumeGroupId = '{{ volumeGroupId }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND displayName = '{{ displayName }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;

INSERT examples

create

Creates a new backup volume group of the specified volume group.<br />For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).<br />

INSERT INTO oci.block_storage.volume_group_backups (
compartmentId,
definedTags,
displayName,
freeformTags,
type,
volumeGroupId,
region,
opc-retry-token
)
SELECT 
'{{ compartmentId }}',
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ type }}',
'{{ volumeGroupId }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
expirationTime,
freeformTags,
lifecycleState,
sizeInGBs,
sizeInMBs,
sourceType,
sourceVolumeGroupBackupId,
timeCreated,
timeRequestReceived,
type,
uniqueSizeInGbs,
uniqueSizeInMbs,
volumeBackupIds,
volumeGroupId
;

Manifest

# Description fields are for documentation purposes
- name: volume_group_backups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the volume_group_backups resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The OCID of the compartment that will contain the volume group
      backup. This parameter is optional, by default backup will be created in
      the same compartment and source volume group.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a
      namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly name. Does not have to be unique, and it's changeable.
      Avoid entering confidential information.
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      Free-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](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: type
    value: "{{ type }}"
    description: |
      The type of backup to create. If omitted, defaults to incremental.
    valid_values: ['FULL', 'INCREMENTAL']
  - name: volumeGroupId
    value: "{{ volumeGroupId }}"
    description: |
      The OCID of the volume group that needs to be backed up.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A 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). 
    description: A 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). 

UPDATE examples

update

Updates the display name for the specified volume group backup. For more information, see Volume Groups.

UPDATE oci.block_storage.volume_group_backups
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
volumeGroupBackupId = '{{ volumeGroupBackupId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
expirationTime,
freeformTags,
lifecycleState,
sizeInGBs,
sizeInMBs,
sourceType,
sourceVolumeGroupBackupId,
timeCreated,
timeRequestReceived,
type,
uniqueSizeInGbs,
uniqueSizeInMbs,
volumeBackupIds,
volumeGroupId;

DELETE examples

delete

Deletes a volume group backup. This operation deletes all the backups in<br />the volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).<br />

DELETE FROM oci.block_storage.volume_group_backups
WHERE volumeGroupBackupId = '{{ volumeGroupBackupId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

change_compartment

Moves a volume group backup into a different compartment within the same tenancy.<br />For information about moving resources between compartments,<br />see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

EXEC oci.block_storage.volume_group_backups.change_compartment 
@volumeGroupBackupId='{{ volumeGroupBackupId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

copy_volume_group_backup

Creates a volume group backup copy in specified region. For general information about volume group backups,<br />see [Overview of Block Volume Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm).<br />

EXEC oci.block_storage.volume_group_backups.copy_volume_group_backup 
@volumeGroupBackupId='{{ volumeGroupBackupId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}' 
@@json=
'{
"destinationRegion": "{{ destinationRegion }}", 
"displayName": "{{ displayName }}", 
"kmsKeyId": "{{ kmsKeyId }}"
}'
;