REST Resource: projects.locations.databases

Resource: Database

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

JSON representation 
{
  "name": string,
  "dbName": string,
  "dbUniqueName": string,
  "adminPassword": string,
  "tdeWalletPassword": string,
  "characterSet": string,
  "ncharacterSet": string,
  "ociUrl": string,
  "createTime": string,
  "properties": {
    object (DatabaseProperties)
  },
  "databaseId": string,
  "dbHomeName": string,
  "gcpOracleZone": string,
  "opsInsightsStatus": enum (OperationsInsightsStatus)
}
Fields
name

string

Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
dbName

string

Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
dbUniqueName

string

Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
adminPassword

string

Required. The password for the default ADMIN user.
tdeWalletPassword

string

Optional. The TDE wallet password for the database.
characterSet

string

Optional. The character set for the database. The default is AL32UTF8.
ncharacterSet

string

Optional. The national character set for the database. The default is AL16UTF16.
ociUrl

string

Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
createTime

string (Timestamp format)

Output only. The date and time that the Database was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
properties

object (DatabaseProperties)

Optional. The properties of the Database.
databaseId

string

Optional. The database ID of the Database.
dbHomeName

string

Optional. The name of the DbHome resource associated with the Database.
gcpOracleZone

string

Output only. The GCP Oracle zone where the Database is created.
opsInsightsStatus

enum (OperationsInsightsStatus)

Output only. The Status of Operations Insights for this Database.

DatabaseProperties

The properties of a Database.

JSON representation 
{
  "state": enum (DatabaseLifecycleState),
  "dbVersion": string,
  "dbBackupConfig": {
    object (DbBackupConfig)
  },
  "databaseManagementConfig": {
    object (DatabaseManagementConfig)
  }
}
Fields
state

enum (DatabaseLifecycleState)

Output only. State of the Database.
dbVersion

string

Required. The Oracle Database version.
dbBackupConfig

object (DbBackupConfig)

Optional. Backup options for the Database.
databaseManagementConfig

object (DatabaseManagementConfig)

Output only. The Database Management config.

DatabaseLifecycleState

The various lifecycle states of the Database.

Enums
DATABASE_LIFECYCLE_STATE_UNSPECIFIED Default unspecified value.
PROVISIONING Indicates that the resource is in provisioning state.
AVAILABLE Indicates that the resource is in available state.
UPDATING Indicates that the resource is in updating state.
BACKUP_IN_PROGRESS Indicates that the resource is in backup in progress state.
UPGRADING Indicates that the resource is in upgrading state.
CONVERTING Indicates that the resource is in converting state.
TERMINATING Indicates that the resource is in terminating state.
TERMINATED Indicates that the resource is in terminated state.
RESTORE_FAILED Indicates that the resource is in restore failed state.
FAILED Indicates that the resource is in failed state.

DbBackupConfig

Backup Options for the Database.

JSON representation 
{
  "autoBackupEnabled": boolean,
  "backupDestinationDetails": [
    {
      object (BackupDestinationDetails)
    }
  ],
  "retentionPeriodDays": integer,
  "backupDeletionPolicy": enum (BackupDeletionPolicy),
  "autoFullBackupDay": enum (DayOfWeek),
  "autoFullBackupWindow": enum (BackupWindow),
  "autoIncrementalBackupWindow": enum (BackupWindow)
}
Fields
autoBackupEnabled

boolean

Optional. If set to true, enables automatic backups on the database.
backupDestinationDetails[]

object (BackupDestinationDetails)

Optional. Details of the database backup destinations.
retentionPeriodDays

integer

Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.
backupDeletionPolicy

enum (BackupDeletionPolicy)

Optional. This defines when the backups will be deleted after Database termination.
autoFullBackupDay

enum (DayOfWeek)

Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.
autoFullBackupWindow

enum (BackupWindow)

Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.
autoIncrementalBackupWindow

enum (BackupWindow)

Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.

BackupDestinationDetails

The details of the database backup destination.

JSON representation 
{
  "type": enum (BackupDestinationType)
}
Fields
type

enum (BackupDestinationType)

Optional. The type of the database backup destination.

BackupDestinationType

The type of the database backup destination.

Enums
BACKUP_DESTINATION_TYPE_UNSPECIFIED Default unspecified value.
NFS Backup destination type is NFS.
RECOVERY_APPLIANCE Backup destination type is Recovery Appliance.
OBJECT_STORE Backup destination type is Object Store.
LOCAL Backup destination type is Local.
DBRS Backup destination type is DBRS.

BackupDeletionPolicy

This defines when the backups will be deleted after Database termination.

Enums
BACKUP_DELETION_POLICY_UNSPECIFIED Default unspecified value.
DELETE_IMMEDIATELY Keeps the backup for predefined time i.e. 72 hours and then delete permanently.
DELETE_AFTER_RETENTION_PERIOD Keeps the backups as per the policy defined for database backups.

BackupWindow

The 2 hour window in which the backup should be performed on the database.

Enums
BACKUP_WINDOW_UNSPECIFIED Default unspecified value.
SLOT_ONE 12:00 AM - 2:00 AM
SLOT_TWO 2:00 AM - 4:00 AM
SLOT_THREE 4:00 AM - 6:00 AM
SLOT_FOUR 6:00 AM - 8:00 AM
SLOT_FIVE 8:00 AM - 10:00 AM
SLOT_SIX 10:00 AM - 12:00 PM
SLOT_SEVEN 12:00 PM - 2:00 PM
SLOT_EIGHT 2:00 PM - 4:00 PM
SLOT_NINE 4:00 PM - 6:00 PM
SLOT_TEN 6:00 PM - 8:00 PM
SLOT_ELEVEN 8:00 PM - 10:00 PM
SLOT_TWELVE 10:00 PM - 12:00 AM

OperationsInsightsStatus

The Status of Operations Insights for this Database.

Enums
OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED Default unspecified value.
ENABLING Indicates that the operations insights are being enabled.
ENABLED Indicates that the operations insights are enabled.
DISABLING Indicates that the operations insights are being disabled.
NOT_ENABLED Indicates that the operations insights are not enabled.
FAILED_ENABLING Indicates that the operations insights failed to enable.
FAILED_DISABLING Indicates that the operations insights failed to disable.

Methods

get

 Gets details of a single Database.

list

 Lists all the Databases for the given project, location and DbSystem.