Jump to

• Request
• Response

Fleet Schedule Backup

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/databases/actions/bulkSubmitBackup

Schedules backup of multiple databases. If the selected destination is an Oracle Zero Data Loss Recovery Appliance, then you must enable the ZDLRA Management Pack on the Recovery Appliance to use this API.

Request

Header Parameters

• ORCL-EM-DBTARGET-AUTHORIZATION(required):
  Database credentials used to connect to the databases.
• ORCL-EM-HOSTTARGET-AUTHORIZATION(required):
  Host credentials that are operating system credentials used to perform database backup and recovery operations.
• ORCL-EM-RMANTARGET-AUTHORIZATION:
  Named credential for RMAN encryption password.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Parameters for creating a backup.

Match All

Parameters for creating a backup.

Show Source

• object BackupDetailsCommon
  Parameters for creating a backup.

{
    "type":"object",
    "description":"Parameters for creating a backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BackupDetailsCommon"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/CreateBackupDetailsControlFile"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsTapeSuggested"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsTapeCustom"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsOCI"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsDiskCustom"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsDiskSuggested"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsRASuggested"
        }
    ]
}

Match One Schema

Show Source

• Control file Backup Strategy
• CreateBackupDetailsTapeSuggested
  Parameters for creating tape suggested backup.
• CreateBackupDetailsTapeCustom
  Parameters for creating tape custom backup.
• CreateBackupDetailsOCI
  Parameters for creating OCI backup.
• CreateBackupDetailsDiskCustom
  Parameters for creating disk custom backup.
• CreateBackupDetailsDiskSuggested
  Parameters for creating disk suggested backup.
• CreateBackupDetailsRASuggested
  Parameters for creating Recovery Appliance suggested backup.

{
    "type":"object",
    "description":"Parameters for creating a backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BackupDetailsCommon"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/CreateBackupDetailsControlFile"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsTapeSuggested"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsTapeCustom"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsOCI"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsDiskCustom"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsDiskSuggested"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsRASuggested"
        }
    ]
}

Nested Schema : BackupDetailsCommon

Type: object

Parameters for creating a backup.

Show Source

• backupStrategy: string
  Allowed Values: [ "ORACLE_SUGGESTED", "CUSTOM", "CONTROL_FILE" ]

  Backup strategy.

  Example: ORACLE_SUGGESTED
• destinationMediaType: string
  Allowed Values: [ "OCI", "RA" ]

  Destination media type.

  Example: RA
• targets: array Targets
  List of database targets.

{
    "description":"Parameters for creating a backup.",
    "type":"object",
    "properties":{
        "targets":{
            "$ref":"#/components/schemas/Targets"
        },
        "backupStrategy":{
            "type":"string",
            "description":"Backup strategy.",
            "enum":[
                "ORACLE_SUGGESTED",
                "CUSTOM",
                "CONTROL_FILE"
            ],
            "example":"ORACLE_SUGGESTED"
        },
        "destinationMediaType":{
            "type":"string",
            "description":"Destination media type.",
            "enum":[
                "OCI",
                "RA"
            ],
            "example":"RA"
        }
    }
}

Nested Schema : CreateBackupDetailsTapeSuggested

Parameters for creating tape suggested backup.

Match All

Parameters for creating tape suggested backup.

Parameters for creating tape suggested backup.

Show Source

• object BackupDetailsTapeSuggested
  Parameters for creating a backup.
• object BackupDetailsDPParamsSchedule
  Parameters for scheduling a backup.

{
    "description":"Parameters for creating tape suggested backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BackupDetailsTapeSuggested"
        },
        {
            "$ref":"#/components/schemas/BackupDetailsDPParamsSchedule"
        }
    ]
}

Nested Schema : CreateBackupDetailsTapeCustom

Parameters for creating tape custom backup.

Match All

Parameters for creating tape custom backup.

Parameters for creating tape custom backup.

Parameters for creating tape custom backup.

Show Source

• object BackupDetailsEncryption
  Parameters for creating a backup.
• object CreateBackupDetailsBase
  Parameters for creating a backup.
• object BackupDetailsDPParamsSchedule
  Parameters for scheduling a backup.

{
    "description":"Parameters for creating tape custom backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BackupDetailsEncryption"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsBase"
        },
        {
            "$ref":"#/components/schemas/BackupDetailsDPParamsSchedule"
        }
    ]
}

Nested Schema : CreateBackupDetailsOCI

Parameters for creating OCI backup.

Match All

Parameters for creating OCI backup.

Parameters for creating OCI backup.

Parameters for creating OCI backup.

Show Source

• object CreateBackupDetailsBase
  Parameters for creating a backup.
• object BackupDetailsEncryption
  Parameters for creating a backup.
• object BackupDetailsDPParamsSchedule
  Parameters for scheduling a backup.

{
    "description":"Parameters for creating OCI backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateBackupDetailsBase"
        },
        {
            "$ref":"#/components/schemas/BackupDetailsEncryption"
        },
        {
            "$ref":"#/components/schemas/BackupDetailsDPParamsSchedule"
        }
    ]
}

Nested Schema : CreateBackupDetailsDiskCustom

Parameters for creating disk custom backup.

Match All

Parameters for creating disk custom backup.

Parameters for creating disk custom backup.

Parameters for creating disk custom backup.

Show Source

• object BackupDetailsEncryption
  Parameters for creating a backup.
• object CreateBackupDetailsBase
  Parameters for creating a backup.
• object BackupDetailsDPParamsSchedule
  Parameters for scheduling a backup.

{
    "description":"Parameters for creating disk custom backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BackupDetailsEncryption"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsBase"
        },
        {
            "$ref":"#/components/schemas/BackupDetailsDPParamsSchedule"
        }
    ]
}

Nested Schema : CreateBackupDetailsDiskSuggested

Parameters for creating disk suggested backup.

Match All

Parameters for creating disk suggested backup.

Parameters for creating disk suggested backup.

Show Source

• object BackupDetailsEncryption
  Parameters for creating a backup.
• object BackupDetailsDPParamsSchedule
  Parameters for scheduling a backup.

{
    "description":"Parameters for creating disk suggested backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BackupDetailsEncryption"
        },
        {
            "$ref":"#/components/schemas/BackupDetailsDPParamsSchedule"
        }
    ]
}

Nested Schema : CreateBackupDetailsRASuggested

Parameters for creating Recovery Appliance suggested backup.

Match All

Parameters for creating Recovery Appliance suggested backup.

Parameters for creating Recovery Appliance suggested backup.

Show Source

• object BackupDetailsRASuggested
  Parameters for creating a backup.
• object BackupDetailsDPParamsSchedule
  Parameters for scheduling a backup.

{
    "description":"Parameters for creating Recovery Appliance suggested backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BackupDetailsRASuggested"
        },
        {
            "$ref":"#/components/schemas/BackupDetailsDPParamsSchedule"
        }
    ]
}

Nested Schema : Targets

Type: array

List of database targets.

Show Source

• Array of: object items

{
    "description":"List of database targets.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "targetName":{
                "type":"string",
                "description":"Target name.",
                "example":"DB1"
            },
            "targetTypeName":{
                "type":"string",
                "description":"Target type.",
                "example":"oracle_database"
            },
            "rmanEncryptionCredentials":{
                "type":"string",
                "description":"Named credential for RMAN encryption password at a database target level.",
                "example":"NAMED:RMAN:SYSMAN"
            }
        }
    },
    "example":[
        {
            "targetName":"DB1",
            "targetTypeName":"oracle_database",
            "rmanEncryptionCredentials":"NAMED:RMAN:SYSMAN"
        },
        {
            "targetName":"DB2",
            "targetTypeName":"rac_database"
        }
    ]
}

Example:

[
    {
        "targetName":"DB1",
        "targetTypeName":"oracle_database",
        "rmanEncryptionCredentials":"NAMED:RMAN:SYSMAN"
    },
    {
        "targetName":"DB2",
        "targetTypeName":"rac_database"
    }
]

Nested Schema : items

Type: object

Show Source

• rmanEncryptionCredentials: string
  Named credential for RMAN encryption password at a database target level.

  Example: NAMED:RMAN:SYSMAN
• targetName: string
  Target name.

  Example: DB1
• targetTypeName: string
  Target type.

  Example: oracle_database

{
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Target name.",
            "example":"DB1"
        },
        "targetTypeName":{
            "type":"string",
            "description":"Target type.",
            "example":"oracle_database"
        },
        "rmanEncryptionCredentials":{
            "type":"string",
            "description":"Named credential for RMAN encryption password at a database target level.",
            "example":"NAMED:RMAN:SYSMAN"
        }
    }
}

Nested Schema : BackupDetailsTapeSuggested

Type: object

Parameters for creating a backup.

Show Source

• mmvLibraryParameters: string
  Media Management Vendor library parameters.

  Example: SBT_LIBRARY=C:\DB19c\obase\ohome\db_home1\bin\oraopc.dll,SBT_PARMS=(OPC_PFILE=C:\DB19c\obase\ohome\db_home1\dbs\opcwcdb19.ora)
• recoveryWindowInDays: integer
  Recovery window in days.

  Example: 31
• tapeDrives: integer
  Tape drives.

  Example: 1

{
    "description":"Parameters for creating a backup.",
    "type":"object",
    "properties":{
        "tapeDrives":{
            "type":"integer",
            "description":"Tape drives.",
            "example":1
        },
        "recoveryWindowInDays":{
            "type":"integer",
            "description":"Recovery window in days.",
            "example":31
        },
        "mmvLibraryParameters":{
            "type":"string",
            "description":"Media Management Vendor library parameters.",
            "example":"SBT_LIBRARY=C:\\DB19c\\obase\\ohome\\db_home1\\bin\\oraopc.dll,SBT_PARMS=(OPC_PFILE=C:\\DB19c\\obase\\ohome\\db_home1\\dbs\\opcwcdb19.ora)"
        }
    }
}

Nested Schema : BackupDetailsDPParamsSchedule

Type: object

Parameters for scheduling a backup.

Show Source

• schedule: Discriminator: type
  Discriminator: { "propertyName":"type", "mapping":{ "immediately":"#/components/schemas/ScheduleImmediately", "later":"#/components/schemas/ScheduleLater", "repeating":"#/components/schemas/ScheduleRepeating" } }

  Specifies schedule of the deployment procedure..

{
    "description":"Parameters for scheduling a backup.",
    "type":"object",
    "properties":{
        "schedule":{
            "description":"Specifies schedule of the deployment procedure..",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ScheduleImmediately"
                },
                {
                    "$ref":"#/components/schemas/ScheduleLater"
                },
                {
                    "$ref":"#/components/schemas/ScheduleRepeating"
                }
            ],
            "discriminator":{
                "propertyName":"type",
                "mapping":{
                    "immediately":"#/components/schemas/ScheduleImmediately",
                    "later":"#/components/schemas/ScheduleLater",
                    "repeating":"#/components/schemas/ScheduleRepeating"
                }
            }
        }
    }
}

Nested Schema : Discriminator: type

Type: object

Discriminator: type

Discriminator Values

• immediately
• later
• repeating

{
    "description":"Specifies schedule of the deployment procedure..",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleImmediately"
        },
        {
            "$ref":"#/components/schemas/ScheduleLater"
        },
        {
            "$ref":"#/components/schemas/ScheduleRepeating"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "immediately":"#/components/schemas/ScheduleImmediately",
            "later":"#/components/schemas/ScheduleLater",
            "repeating":"#/components/schemas/ScheduleRepeating"
        }
    }
}

Specifies schedule of the deployment procedure..

Match One Schema

Show Source

• immediately - object ScheduleImmediately
  Schedule immediately.
• later - object ScheduleLater
  Schedule later.
• object Discriminator: repeatFrequency
  Discriminator: { "propertyName":"repeatFrequency", "mapping":{ "WEEKLY":"#/components/schemas/ScheduleWeekly", "MONTHLY":"#/components/schemas/ScheduleMonthly", "YEARLY":"#/components/schemas/ScheduleYearly", "INTERVAL":"#/components/schemas/ScheduleInterval" } }

  Repeating schedule.

{
    "description":"Specifies schedule of the deployment procedure..",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleImmediately"
        },
        {
            "$ref":"#/components/schemas/ScheduleLater"
        },
        {
            "$ref":"#/components/schemas/ScheduleRepeating"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "immediately":"#/components/schemas/ScheduleImmediately",
            "later":"#/components/schemas/ScheduleLater",
            "repeating":"#/components/schemas/ScheduleRepeating"
        }
    }
}

Nested Schema : ScheduleImmediately

Type: object

Schedule immediately.

Show Source

• type(required): string
  Type of schedule.

  Example: immediately

{
    "type":"object",
    "description":"Schedule immediately.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"immediately"
        }
    }
}

Nested Schema : ScheduleLater

Type: object

Schedule later.

Show Source

• startTime: date-time
  Date when the deployment procedure is scheduled to start. Specified as a string in the format yyyy/MM/dd HH:mm.

  Example: 2021/08/30 23:00
• timeZone: string
  Java Timezone.

  Example: America/New_York
• type(required): string
  Type of schedule.

  Example: later

{
    "type":"object",
    "description":"Schedule later.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"later"
        },
        "startTime":{
            "$ref":"#/components/schemas/ScheduleStartTime"
        },
        "timeZone":{
            "$ref":"#/components/schemas/ScheduleTimeZone"
        }
    }
}

Nested Schema : Discriminator: repeatFrequency

Type: object

Discriminator: repeatFrequency

Discriminator Values

• WEEKLY
• MONTHLY
• YEARLY
• INTERVAL

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

Repeating schedule.

Match All

Repeating schedule.

Show Source

• object ScheduleRepeatingBase
  Repeating schedule.

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

Match One Schema

Show Source

• WEEKLY - object ScheduleWeekly
  Repeat value for repeat frequency - weekly.
• MONTHLY - object ScheduleMonthly
  Repeat value for repeat frequency - monthly.
• YEARLY - object ScheduleYearly
  Repeat value for repeat frequency - yearly.
• INTERVAL - object ScheduleInterval
  Repeat value for repeat frequency - interval.

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

Nested Schema : ScheduleRepeatingBase

Type: object

Repeating schedule.

Show Source

• endtime: date-time
  Date when job expires. Specified as a string in the format yyyy/MM/dd HH:mm. If not specified, repeat would be on forever.

  Example: 2021/08/30 23:00
• repeatFrequency(required): string
  Allowed Values: [ "WEEKLY", "MONTHLY", "YEARLY", "INTERVAL" ]

  Repetitive frequency type.
• startTime(required): date-time
  Date when the deployment procedure is scheduled to start. Specified as a string in the format yyyy/MM/dd HH:mm.

  Example: 2021/08/30 23:00
• timeZone: string
  Java Timezone.

  Example: America/New_York
• type(required): string
  Type of schedule.

  Example: repeating

{
    "type":"object",
    "description":"Repeating schedule.",
    "required":[
        "type",
        "startTime",
        "repeatFrequency"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"repeating"
        },
        "startTime":{
            "$ref":"#/components/schemas/ScheduleStartTime"
        },
        "timeZone":{
            "$ref":"#/components/schemas/ScheduleTimeZone"
        },
        "endtime":{
            "$ref":"#/components/schemas/ScheduleEndTime"
        },
        "repeatFrequency":{
            "$ref":"#/components/schemas/ScheduleRepeatFrequency"
        }
    }
}

Nested Schema : ScheduleWeekly

Type: object

Repeat value for repeat frequency - weekly.

Show Source

• days(required): array days
  Days of the week.

{
    "description":"Repeat value for repeat frequency - weekly.",
    "required":[
        "days"
    ],
    "properties":{
        "days":{
            "description":"Days of the week.",
            "type":"array",
            "example":"1,4",
            "items":{
                "$ref":"#/components/schemas/DaysOfTheWeekEnum"
            }
        }
    }
}

Nested Schema : ScheduleMonthly

Type: object

Repeat value for repeat frequency - monthly.

Show Source

• days(required): array days
  Repeat value for monthly.

{
    "description":"Repeat value for repeat frequency - monthly.",
    "required":[
        "days"
    ],
    "properties":{
        "days":{
            "description":"Repeat value for monthly.",
            "type":"array",
            "example":"1,30,31",
            "items":{
                "type":"integer",
                "description":"Day number, int -1, 1..5 representing which day number. -1 represents LAST day."
            }
        }
    }
}

Nested Schema : ScheduleYearly

Type: object

Repeat value for repeat frequency - yearly.

Show Source

• months(required): array months
  Repeat value for yearly.

{
    "description":"Repeat value for repeat frequency - yearly.",
    "required":[
        "months"
    ],
    "properties":{
        "months":{
            "description":"Repeat value for yearly.",
            "type":"array",
            "example":"1,3",
            "items":{
                "type":"integer",
                "description":"Month number, int 1, 2, 3.. representing months Januaray, February, March etc."
            }
        }
    }
}

Nested Schema : ScheduleInterval

Type: object

Repeat value for repeat frequency - interval.

Show Source

• repeatEvery(required): string
  Repeat every N value - m(minutes), h(hours), d(days), w(week).

  Example: 10m, 3h, 5d, 2w

{
    "description":"Repeat value for repeat frequency - interval.",
    "required":[
        "repeatEvery"
    ],
    "properties":{
        "repeatEvery":{
            "description":"Repeat every N value - m(minutes), h(hours), d(days), w(week).",
            "type":"string",
            "example":"10m, 3h, 5d, 2w"
        }
    }
}

Nested Schema : days

Type: array

Days of the week.

Show Source

• Array of: integer
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7 ]

  Days of the week, Sunday is 1, Monday is 2 etc.

{
    "description":"Days of the week.",
    "type":"array",
    "example":"1,4",
    "items":{
        "$ref":"#/components/schemas/DaysOfTheWeekEnum"
    }
}

Example:

1,4

Nested Schema : days

Type: array

Repeat value for monthly.

Show Source

• Array of: integer
  Day number, int -1, 1..5 representing which day number. -1 represents LAST day.

{
    "description":"Repeat value for monthly.",
    "type":"array",
    "example":"1,30,31",
    "items":{
        "type":"integer",
        "description":"Day number, int -1, 1..5 representing which day number. -1 represents LAST day."
    }
}

Example:

1,30,31

Nested Schema : months

Type: array

Repeat value for yearly.

Show Source

• Array of: integer
  Month number, int 1, 2, 3.. representing months Januaray, February, March etc.

{
    "description":"Repeat value for yearly.",
    "type":"array",
    "example":"1,3",
    "items":{
        "type":"integer",
        "description":"Month number, int 1, 2, 3.. representing months Januaray, February, March etc."
    }
}

Example:

1,3

Nested Schema : BackupDetailsEncryption

Type: object

Parameters for creating a backup.

Show Source

• backupEncryptionMode: string
  Allowed Values: [ "WALLET", "PASSWORD", "BOTH" ]

  Backup Encryption Mode

  Example: PASSWORD
• encryptionAlogrithm: string
  Allowed Values: [ "AES128", "AES192", "AES256" ]

  Encryption Alogrithm

  Example: AES128

{
    "description":"Parameters for creating a backup.",
    "type":"object",
    "properties":{
        "backupEncryptionMode":{
            "type":"string",
            "description":"Backup Encryption Mode",
            "enum":[
                "WALLET",
                "PASSWORD",
                "BOTH"
            ],
            "example":"PASSWORD"
        },
        "encryptionAlogrithm":{
            "type":"string",
            "description":"Encryption Alogrithm",
            "enum":[
                "AES128",
                "AES192",
                "AES256"
            ],
            "example":"AES128"
        }
    }
}

Nested Schema : CreateBackupDetailsBase

Type: object

Parameters for creating a backup.

Show Source

• backupScope: string
  Allowed Values: [ "WHOLE" ]

  Backup Scope.

  Example: WHOLE
• backupType: string
  Allowed Values: [ "FULL", "INCREMENTAL0", "INCREMENTAL1" ]

  Backup Type.

  Example: INCREMENTAL0
• incrementalType: string
  Allowed Values: [ "DIFFERENTIAL", "CUMULATIVE" ]

  Incremental Type.

  Example: DIFFERENTIAL
• isDeleteArchivedLogsPostBackup: boolean
  Specifies if the archived logs have to be deleted after a successful backup.

  Example: false
• isDeleteObsoleteBackups: boolean
  Specifies if the obsolete backups have to be deleted.

  Example: false
• isSkipBackupArchivedLogs: boolean
  Specifies if archived logs have to be skipped during backup.

  Example: false
• maxFilesPerSet: integer
  Maximum files per backupset.

  Example: 1
• sectionSizeInMBs: integer
  Section size of the backup.

  Example: 10

{
    "description":"Parameters for creating a backup.",
    "type":"object",
    "properties":{
        "backupScope":{
            "type":"string",
            "description":"Backup Scope.",
            "enum":[
                "WHOLE"
            ],
            "example":"WHOLE"
        },
        "backupType":{
            "type":"string",
            "description":"Backup Type.",
            "enum":[
                "FULL",
                "INCREMENTAL0",
                "INCREMENTAL1"
            ],
            "example":"INCREMENTAL0"
        },
        "incrementalType":{
            "type":"string",
            "description":"Incremental Type.",
            "enum":[
                "DIFFERENTIAL",
                "CUMULATIVE"
            ],
            "example":"DIFFERENTIAL"
        },
        "isSkipBackupArchivedLogs":{
            "type":"boolean",
            "description":"Specifies if archived logs have to be skipped during backup.",
            "example":false
        },
        "isDeleteArchivedLogsPostBackup":{
            "type":"boolean",
            "description":"Specifies if the archived logs have to be deleted after a successful backup.",
            "example":false
        },
        "isDeleteObsoleteBackups":{
            "type":"boolean",
            "description":"Specifies if the obsolete backups have to be deleted.",
            "example":false
        },
        "maxFilesPerSet":{
            "type":"integer",
            "description":"Maximum files per backupset.",
            "example":1
        },
        "sectionSizeInMBs":{
            "type":"integer",
            "description":"Section size of the backup.",
            "example":10
        }
    }
}

Nested Schema : BackupDetailsRASuggested

Type: object

Parameters for creating a backup.

Show Source

• isCrosscheckArchivelog: boolean
  Specifies whether the crosscheck archived log has to be performed.

  Example: true
• isDeleteArchivedLogsPostBackup: boolean
  Specifies whether the archived log has be deleted after a successful backup.

  Example: true

{
    "description":"Parameters for creating a backup.",
    "type":"object",
    "properties":{
        "isCrosscheckArchivelog":{
            "type":"boolean",
            "description":"Specifies whether the crosscheck archived log has to be performed.",
            "example":true
        },
        "isDeleteArchivedLogsPostBackup":{
            "type":"boolean",
            "description":"Specifies whether the archived log has be deleted after a successful backup.",
            "example":true
        }
    }
}

Examples

Select an example Recovery Appliance OCI Object Storage Control File DISK SUGGESTED DISK CUSTOM TAPE SUGGESTED TAPE CUSTOM

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted.

Headers

• Content-Location:
  Execution details of the deployment procedure submitted.
• ORCL-EM-PROCESSING-TIME:
  Elapsed time (in milliseconds) since the deployment procedure is submitted.

Body ()

Root Schema : BulkSubmitBackupDatabase

Type: object

Backup Deployment Procedure Status

Show Source

• code(required): integer
  HTTP Status code

  Example: 202
• executionId(required): string
  Deployment procedure execution ID.
• instanceName(required): string
  Instance name of the deployment procedure submitted.
• procedureId(required): string
  Deployment procedure submission ID.
• submissionBy(required): string
  User that submitted the deployment procedure.
• submissionName(required): string
  Name of the deployment procedure submitted.

{
    "description":"Backup Deployment Procedure Status",
    "type":"object",
    "required":[
        "code",
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId",
        "instanceName"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status code",
            "type":"integer",
            "example":202
        },
        "submissionName":{
            "description":"Name of the deployment procedure submitted.",
            "type":"string"
        },
        "submissionBy":{
            "description":"User that submitted the deployment procedure.",
            "type":"string"
        },
        "executionId":{
            "description":"Deployment procedure execution ID.",
            "type":"string"
        },
        "procedureId":{
            "description":"Deployment procedure submission ID.",
            "type":"string"
        },
        "instanceName":{
            "description":"Instance name of the deployment procedure submitted.",
            "type":"string"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

409 Response

Duplicate Resource

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top