VolumeGroupBackup

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-volume-group-backup-schema.json",
  "title": "VolumeGroupBackup",
  "description": "A point-in-time copy of a volume group that can then be used to create a new volume group\nor restore a volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,\ntalk to an administrator. If you're an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).\n\n**Warning:** Oracle recommends that you avoid using any confidential information when you\nsupply string values using the API.\n",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-blockstorage-api-openapi.yml#/components/schemas/VolumeGroupBackup",
  "properties": {
    "compartmentId": {
      "description": "The OCID of the compartment that contains the volume group backup.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a\nnamespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "A user-friendly name. Does not have to be unique, and it's changeable.\nAvoid entering confidential information.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "expirationTime": {
      "description": "The date and time the volume group backup will expire and be automatically deleted.\nFormat defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for volume group\nbackups that were created automatically by a scheduled-backup policy. For manually\ncreated volume group backups, it will be absent, signifying that there is no expiration\ntime and the backup will last forever until manually deleted.\n",
      "format": "date-time",
      "type": "string"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no\npredefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "The OCID of the volume group backup.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "isIndefiniteRetentionEnabled": {
      "description": "feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups.",
      "type": "boolean"
    },
    "isPreventDeletionEnabled": {
      "description": "Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.",
      "type": "boolean"
    },
    "isRetentionLockEnabled": {
      "description": "feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.",
      "type": "boolean"
    },
    "lifecycleState": {
      "description": "The current state of a volume group backup.",
      "enum": [
        "CREATING",
        "COMMITTED",
        "AVAILABLE",
        "TERMINATING",
        "TERMINATED",
        "FAULTY",
        "REQUEST_RECEIVED"
      ],
      "type": "string"
    },
    "retentionPeriod": {
      "$ref": "#/$defs/RetentionDuration"
    },
    "sizeInGBs": {
      "description": "The aggregate size of the volume group backup, in GBs.\n",
      "format": "int64",
      "type": "integer"
    },
    "sizeInMBs": {
      "description": "The aggregate size of the volume group backup, in MBs.\n",
      "format": "int64",
      "type": "integer"
    },
    "sourceType": {
      "description": "Specifies whether the volume group backup was created manually, or via scheduled\nbackup policy.\n",
      "enum": [
        "MANUAL",
        "SCHEDULED"
      ],
      "type": "string"
    },
    "sourceVolumeGroupBackupId": {
      "description": "The OCID of the source volume group backup.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "timeCreated": {
      "description": "The date and time the volume group backup was created. This is the time the actual point-in-time image\nof the volume group data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n",
      "format": "date-time",
      "type": "string"
    },
    "timeRequestReceived": {
      "description": "The date and time the request to create the volume group backup was received. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n",
      "format": "date-time",
      "type": "string"
    },
    "timeRetentionExpiresAt": {
      "description": "The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups.",
      "format": "date-time",
      "type": "string"
    },
    "type": {
      "description": "The type of backup.",
      "enum": [
        "FULL",
        "INCREMENTAL"
      ],
      "type": "string"
    },
    "uniqueSizeInGbs": {
      "description": "The aggregate size used by the volume group backup, in GBs.\n\nIt is typically smaller than sizeInGBs, depending on the spaceconsumed\non the volume group and whether the volume backup is full or incremental.\n",
      "format": "int64",
      "type": "integer"
    },
    "uniqueSizeInMbs": {
      "description": "The aggregate size used by the volume group backup, in MBs.\n\nIt is typically smaller than sizeInMBs, depending on the spaceconsumed\non the volume group and whether the volume backup is full or incremental.\n",
      "format": "int64",
      "type": "integer"
    },
    "volumeBackupIds": {
      "description": "OCIDs for the volume backups in this volume group backup.",
      "items": {
        "maxLength": 255,
        "minLength": 1,
        "type": "string"
      },
      "maxItems": 64,
      "type": "array"
    },
    "volumeGroupId": {
      "description": "The OCID of the source volume group.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "id",
    "volumeBackupIds",
    "displayName",
    "compartmentId",
    "timeCreated",
    "type",
    "lifecycleState"
  ],
  "$defs": {
    "RetentionDuration": {
      "description": "This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups.",
      "properties": {
        "retentionTimeAmount": {
          "description": "The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period.",
          "type": "integer"
        },
        "retentionTimeUnit": {
          "description": "The value you can assign to the Time Unit property for this Duration may be either \"YEARS\" or \"DAYS\".",
          "enum": [
            "YEARS",
            "DAYS"
          ],
          "type": "string"
        }
      },
      "required": [
        "retentionTimeUnit",
        "retentionTimeAmount"
      ]
    }
  }
}