Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace VolumeGroupBackup

A point-in-time copy of a volume group that can then be used to create a new volume group or restore a volume group. For more information, see Volume Groups.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the volume group backup.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

displayName

displayName: string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional expirationTime

expirationTime: Date

The date and time the volume group backup will expire and be automatically deleted. Format defined by 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.

Optional freeformTags

freeformTags: undefined | 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.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the volume group backup.

lifecycleState

lifecycleState: LifecycleState

The current state of a volume group backup.

Optional sizeInGBs

sizeInGBs: undefined | number

The aggregate size of the volume group backup, in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional sizeInMBs

sizeInMBs: undefined | number

The aggregate size of the volume group backup, in MBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional sourceType

sourceType: SourceType

Specifies whether the volume group backup was created manually, or via scheduled backup policy.

Optional sourceVolumeGroupBackupId

sourceVolumeGroupBackupId: undefined | string

The OCID of the source volume group backup.

timeCreated

timeCreated: Date

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.

Optional timeRequestReceived

timeRequestReceived: Date

The date and time the request to create the volume group backup was received. Format defined by RFC3339.

type

type: Type

The type of backup.

Optional uniqueSizeInGbs

uniqueSizeInGbs: undefined | number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional uniqueSizeInMbs

uniqueSizeInMbs: undefined | number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

volumeBackupIds

volumeBackupIds: Array<string>

OCIDs for the volume backups in this volume group backup.

Optional volumeGroupId

volumeGroupId: undefined | string

The OCID of the source volume group.

Functions

getDeserializedJsonObj

getJsonObj