Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BackupSummary

Details of Backups such as OCID, description, backupType, and so on.

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/Content/Identity/Concepts/policygetstarted.htm).

Properties

Optional backupSizeInGBs

backupSizeInGBs: undefined | number

The size of the backup in GiBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

backupType

backupType: string

The type of backup.

compartmentId

compartmentId: string

The OCID of the compartment the backup exists in.

creationType

creationType: string

If the backup was created automatically, or by a manual request.

Optional dataStorageSizeInGBs

dataStorageSizeInGBs: undefined | number

Size of the data volume in GiBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

dbSystemId

dbSystemId: string

The OCID of the DB System the Backup is associated with.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

A user-supplied description of the backup.

Optional displayName

displayName: undefined | string

A user-supplied display name for the backup.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

OCID of the backup.

lifecycleState

lifecycleState: string

The state of the backup.

Optional mysqlVersion

mysqlVersion: undefined | string

The version of the DB System used for backup.

Optional retentionInDays

retentionInDays: undefined | number

Number of days to retain this backup. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional shapeName

shapeName: undefined | string

The shape of the DB System instance used for backup.

timeCreated

timeCreated: Date

The time the backup was created.

Functions

getDeserializedJsonObj

getJsonObj