REST Resource: projects.locations.autonomousDatabaseBackups

Resource: AutonomousDatabaseBackup

Details of the Autonomous Database Backup resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/

JSON representation 
{
  "name": string,
  "autonomousDatabase": string,
  "displayName": string,
  "properties": {
    object (AutonomousDatabaseBackupProperties)
  },
  "labels": {
    string: string,
    ...
  }
}
Fields
name

string

Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomousDatabaseBackup}
autonomousDatabase

string

Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project}/locations/{region}/autonomousDatabases/{autonomousDatabase}
displayName

string

Optional. User friendly name for the Backup. The name does not have to be unique.
properties

object (AutonomousDatabaseBackupProperties)

Optional. Various properties of the backup.
labels

map (key: string, value: string)

Optional. labels or tags associated with the resource.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

AutonomousDatabaseBackupProperties

Properties of the Autonomous Database Backup resource.

JSON representation 
{
  "ocid": string,
  "retentionPeriodDays": integer,
  "compartmentId": string,
  "databaseSizeTb": number,
  "dbVersion": string,
  "isLongTermBackup": boolean,
  "isAutomaticBackup": boolean,
  "isRestorable": boolean,
  "keyStoreId": string,
  "keyStoreWallet": string,
  "kmsKeyId": string,
  "kmsKeyVersionId": string,
  "lifecycleDetails": string,
  "lifecycleState": enum (State),
  "sizeTb": number,
  "availableTillTime": string,
  "endTime": string,
  "startTime": string,
  "type": enum (Type),
  "vaultId": string
}
Fields
ocid

string

Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
retentionPeriodDays

integer

Optional. Retention period in days for the backup.
compartmentId

string

Output only. The OCID of the compartment.
databaseSizeTb

number

Output only. The quantity of data in the database, in terabytes.
dbVersion

string

Output only. A valid Oracle Database version for Autonomous Database.
isLongTermBackup

boolean

Output only. Indicates if the backup is long term backup.
isAutomaticBackup

boolean

Output only. Indicates if the backup is automatic or user initiated.
isRestorable

boolean

Output only. Indicates if the backup can be used to restore the Autonomous Database.
keyStoreId

string

Optional. The OCID of the key store of Oracle Vault.
keyStoreWallet

string

Optional. The wallet name for Oracle Key Vault.
kmsKeyId

string

Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId

string

Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
lifecycleDetails

string

Output only. Additional information about the current lifecycle state.
lifecycleState

enum (State)

Output only. The lifecycle state of the backup.
sizeTb

number

Output only. The backup size in terabytes.
availableTillTime

string (Timestamp format)

Output only. Timestamp until when the backup will be available.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Output only. The date and time the backup completed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
startTime

string (Timestamp format)

Output only. The date and time the backup started.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
type

enum (Type)

Output only. The type of the backup.
vaultId

string

Optional. The OCID of the vault.

State

// The various lifecycle states of the Autonomous Database Backup.

Enums
STATE_UNSPECIFIED Default unspecified value.
CREATING Indicates that the resource is in creating state.
ACTIVE Indicates that the resource is in active state.
DELETING Indicates that the resource is in deleting state.
DELETED Indicates that the resource is in deleted state.
FAILED Indicates that the resource is in failed state.
UPDATING Indicates that the resource is in updating state.

Type

The type of the backup.

Enums
TYPE_UNSPECIFIED Default unspecified value.
INCREMENTAL Incremental backups.
FULL Full backups.
LONG_TERM Long term backups.

Methods

list

 Lists the long-term and automatic backups of an Autonomous Database.