REST APIs for Oracle Database Appliance Release 19.26

Create KVM DB System

post

/dbsystem

Create a new KVM DB System in Oracle Database Appliance using DbSystemCreateParams. Make sure Oracle Database Appliance KVM DB System Image is downloaded and the repository is updated with the image first.

Request

Supported Media Types

application/json

Parameters to create a DB System

Root Schema : DbSystemCreateParams

Type: object

Show Source

baseDb: object DbSystemCreateBaseDbParams
database: object DbSystemCreateDatabaseParams
dbHome: object DbSystemCreateDbHomeParams
forced: boolean

Whether or not to force the DB System create operation
grid: object DbSystemCreateGridParams
network(required): object DbSystemCreateNetworkParams
restoreDatabase: object DbSystemCreateRestoreDatabaseParams
system(required): object DbSystemCreateSystemParams

{
    "type":"object",
    "required":[
        "system",
        "network"
    ],
    "properties":{
        "system":{
            "$ref":"#/definitions/DbSystemCreateSystemParams"
        },
        "network":{
            "$ref":"#/definitions/DbSystemCreateNetworkParams"
        },
        "grid":{
            "$ref":"#/definitions/DbSystemCreateGridParams"
        },
        "dbHome":{
            "$ref":"#/definitions/DbSystemCreateDbHomeParams"
        },
        "database":{
            "$ref":"#/definitions/DbSystemCreateDatabaseParams"
        },
        "restoreDatabase":{
            "$ref":"#/definitions/DbSystemCreateRestoreDatabaseParams"
        },
        "baseDb":{
            "$ref":"#/definitions/DbSystemCreateBaseDbParams"
        },
        "forced":{
            "type":"boolean",
            "description":"Whether or not to force the DB System create operation"
        }
    }
}

Nested Schema : DbSystemCreateBaseDbParams

Type: object

Show Source

bootImageId: string

ID of the DB System VM image artifact
bootOptions: string

Boot options for DB System VM
bootstrapRpmId: string

ID of the bootstrap RPM artifact
bootstrapScript: string

Bootstrap script location within DB System VM
ccVersion: string

ASM client cluster version
databag: string

Databag to be placed inside DB System VM
sshKey: string

SSH key for root user in the DB System VM
u01Size: string

Size of the u01 vDisk, defaults to 100G

{
    "type":"object",
    "properties":{
        "bootImageId":{
            "type":"string",
            "description":"ID of the DB System VM image artifact"
        },
        "bootOptions":{
            "type":"string",
            "description":"Boot options for DB System VM"
        },
        "ccVersion":{
            "type":"string",
            "description":"ASM client cluster version"
        },
        "sshKey":{
            "type":"string",
            "description":"SSH key for root user in the DB System VM"
        },
        "databag":{
            "type":"string",
            "description":"Databag to be placed inside DB System VM"
        },
        "bootstrapRpmId":{
            "type":"string",
            "description":"ID of the bootstrap RPM artifact"
        },
        "bootstrapScript":{
            "type":"string",
            "description":"Bootstrap script location within DB System VM"
        },
        "u01Size":{
            "type":"string",
            "description":"Size of the u01 vDisk, defaults to 100G"
        }
    }
}

Nested Schema : DbSystemCreateDatabaseParams

Type: object

Show Source

adminPassword(required): string

Admin password of the database
characterSet: object DbCharacterSet
dbClass(required): string

Allowed Values: [ "OLTP", "DSS", "IMDB" ]

Class of the database (OLTP|DSS|IMDB)
dbStorage: string

Allowed Values: [ "ASM", "PMEM" ]

Storage type of the database (ASM|PMEM) - The default value is ASM
domainName(required): string

Domain name of the database
edition(required): string

Allowed Values: [ "SE", "EE" ]

Edition of the database (SE|EE)
enableDbConsole: boolean

Whether or not the database console is enabled
enableEEHA: boolean

Whether or not to enable HA for EE SI database
enableFlashCache: boolean

Whether or not enable flash cache
enableFlashStorage: boolean

Whether or not enable flash storage
enableSEHA: boolean

Whether or not to enable HA for SE for 19c and later SI database
enableTDE: boolean

Whether or not enable TDE
enableUnifiedAuditing: boolean

Whether or not enable unified auditing
isCdb: boolean

Whether or not the database is CDB
level0BackupDay: string

Allowed Values: [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]

Backup day of the database (monday|tuesday|wednesday|thursday|friday|saturday|sunday)
name(required): string

Name of the database
pdbAdminUser: string

Name of the PDB admin user
pdbName: string

Name of the PDB
redundancy: string

Redundancy of the database. If the diskgroup redundancy is FLEX, then database redundancy must be set to one of "HIGH" or "MIRROR", otherwise, can be null
rmanBackupPassword: string

RMAN backup password of the database
role(required): string

Allowed Values: [ "PRIMARY", "STANDBY" ]

Role of the database (PRIMARY|STANDBY)
shape(required): string

Allowed Values: [ "odb1s", "odb1", "odb2", "odb4", "odb6", "odb8", "odb10", "odb12", "odb16", "odb20", "odb24", "odb28", "odb32", "odb36", "odb42", "odb48", "odb56", "odb64" ]

Shape of the database (odb1s|odb1|odb2|odb4|odb6| odb8|odb10|odb12|odb16|odb20|odb24|odb28|odb32| odb36|odb42|odb48|odb56|odb64)
targetNodeName: string

Target node name of the database
tdePassword: string

TDE password of the database
type(required): string

Allowed Values: [ "RAC", "RACOne", "SI" ]

Type of the database (RAC|RACOne|SI)
uniqueName(required): string

Unique name of the database
version(required): string

Version of the database

{
    "type":"object",
    "required":[
        "name",
        "uniqueName",
        "domainName",
        "adminPassword",
        "version",
        "edition",
        "type",
        "dbClass",
        "shape",
        "role"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the database"
        },
        "uniqueName":{
            "type":"string",
            "description":"Unique name of the database"
        },
        "domainName":{
            "type":"string",
            "description":"Domain name of the database"
        },
        "adminPassword":{
            "type":"string",
            "description":"Admin password of the database"
        },
        "version":{
            "type":"string",
            "description":"Version of the database"
        },
        "edition":{
            "type":"string",
            "description":"Edition of the database (SE|EE)",
            "enum":[
                "SE",
                "EE"
            ]
        },
        "type":{
            "type":"string",
            "description":"Type of the database (RAC|RACOne|SI)",
            "enum":[
                "RAC",
                "RACOne",
                "SI"
            ]
        },
        "dbClass":{
            "type":"string",
            "description":"Class of the database (OLTP|DSS|IMDB)",
            "enum":[
                "OLTP",
                "DSS",
                "IMDB"
            ]
        },
        "shape":{
            "type":"string",
            "description":"Shape of the database (odb1s|odb1|odb2|odb4|odb6| odb8|odb10|odb12|odb16|odb20|odb24|odb28|odb32| odb36|odb42|odb48|odb56|odb64)",
            "enum":[
                "odb1s",
                "odb1",
                "odb2",
                "odb4",
                "odb6",
                "odb8",
                "odb10",
                "odb12",
                "odb16",
                "odb20",
                "odb24",
                "odb28",
                "odb32",
                "odb36",
                "odb42",
                "odb48",
                "odb56",
                "odb64"
            ]
        },
        "role":{
            "type":"string",
            "description":"Role of the database (PRIMARY|STANDBY)",
            "enum":[
                "PRIMARY",
                "STANDBY"
            ]
        },
        "redundancy":{
            "type":"string",
            "description":"Redundancy of the database. If the diskgroup redundancy is FLEX, then database redundancy must be set to one of \"HIGH\" or \"MIRROR\", otherwise, can be null"
        },
        "characterSet":{
            "$ref":"#/definitions/DbCharacterSet"
        },
        "enableDbConsole":{
            "type":"boolean",
            "description":"Whether or not the database console is enabled"
        },
        "enableSEHA":{
            "type":"boolean",
            "description":"Whether or not to enable HA for SE for 19c and later SI database"
        },
        "enableEEHA":{
            "type":"boolean",
            "description":"Whether or not to enable HA for EE SI database"
        },
        "enableFlashStorage":{
            "type":"boolean",
            "description":"Whether or not enable flash storage"
        },
        "enableFlashCache":{
            "type":"boolean",
            "description":"Whether or not enable flash cache"
        },
        "rmanBackupPassword":{
            "type":"string",
            "description":"RMAN backup password of the database"
        },
        "level0BackupDay":{
            "type":"string",
            "description":"Backup day of the database (monday|tuesday|wednesday|thursday|friday|saturday|sunday)",
            "enum":[
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday",
                "saturday",
                "sunday"
            ]
        },
        "enableTDE":{
            "type":"boolean",
            "description":"Whether or not enable TDE"
        },
        "tdePassword":{
            "type":"string",
            "description":"TDE password of the database"
        },
        "enableUnifiedAuditing":{
            "type":"boolean",
            "description":"Whether or not enable unified auditing"
        },
        "isCdb":{
            "type":"boolean",
            "description":"Whether or not the database is CDB"
        },
        "pdbName":{
            "type":"string",
            "description":"Name of the PDB"
        },
        "pdbAdminUser":{
            "type":"string",
            "description":"Name of the PDB admin user"
        },
        "targetNodeName":{
            "type":"string",
            "description":"Target node name of the database"
        },
        "dbStorage":{
            "type":"string",
            "description":"Storage type of the database (ASM|PMEM) - The default value is ASM",
            "enum":[
                "ASM",
                "PMEM"
            ]
        }
    }
}

Nested Schema : DbSystemCreateDbHomeParams

Type: object

Show Source

edition: string

Allowed Values: [ "SE", "EE" ]

Edition of the database home (SE|EE)
enableUnifiedAuditing: boolean

Whether or not enable unified auditing
version(required): string

Version of the database home

{
    "type":"object",
    "required":[
        "version"
    ],
    "properties":{
        "version":{
            "type":"string",
            "description":"Version of the database home"
        },
        "edition":{
            "type":"string",
            "description":"Edition of the database home (SE|EE)",
            "enum":[
                "SE",
                "EE"
            ]
        },
        "enableUnifiedAuditing":{
            "type":"boolean",
            "description":"Whether or not enable unified auditing"
        }
    }
}

Nested Schema : DbSystemCreateGridParams

Type: object

Show Source

enableAFD: boolean

Whether or not AFD is enabled within DB system
language: string

Language setting for the grid installation
version: string

version of the grid home

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "description":"version of the grid home"
        },
        "language":{
            "type":"string",
            "description":"Language setting for the grid installation"
        },
        "enableAFD":{
            "type":"boolean",
            "description":"Whether or not AFD is enabled within DB system"
        }
    }
}

Nested Schema : DbSystemCreateNetworkParams

Type: object

Show Source

clusterInterconnect: object DbSystemClusterInterconnect
dnsServers(required): array dnsServers

DNS servers of the network
domainName(required): string

Domain name of the network
nodes(required): array nodes
ntpServers(required): array ntpServers

NTP servers of the network
publicVNetwork: string

Name of the public virtual network
scanIps: array scanIps

SCAN IPs for the DB system database
scanName: string

SCAN name for the DB system database

{
    "type":"object",
    "required":[
        "domainName",
        "ntpServers",
        "dnsServers",
        "nodes"
    ],
    "properties":{
        "domainName":{
            "type":"string",
            "description":"Domain name of the network"
        },
        "ntpServers":{
            "type":"array",
            "description":"NTP servers of the network",
            "items":{
                "type":"string"
            }
        },
        "dnsServers":{
            "type":"array",
            "description":"DNS servers of the network",
            "items":{
                "type":"string"
            }
        },
        "scanName":{
            "type":"string",
            "description":"SCAN name for the DB system database"
        },
        "scanIps":{
            "type":"array",
            "description":"SCAN IPs for the DB system database",
            "items":{
                "type":"string"
            }
        },
        "nodes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemCreateNetworkNodeParams"
            }
        },
        "publicVNetwork":{
            "description":"Name of the public virtual network",
            "type":"string"
        },
        "clusterInterconnect":{
            "$ref":"#/definitions/DbSystemClusterInterconnect"
        }
    }
}

Nested Schema : DbSystemCreateRestoreDatabaseParams

Type: object

Show Source

backupPasswords: array backupPasswords
backupReportDetails(required): object DbSystemCreateRestoreBackupReportDetails

Details of the backup report that must be used to restore the database within a new DB System
customization: object DbSystemCreateRestoreBackupDatabaseCustomization

Database parameters that can be customized for restored database within a new DB System
enableForceDelete: boolean

Deletes the filegroups, FRA and archived logs of database that is getting created from backup, if present
numberOfRmanChannels: integer

Number of RMAN channel that must be used while creating the database from backup
sourceDetails(required): object DbSystemCreateRestoreBackupSourceDetails

Details of the backup and its destination
sysPassword(required): string

Admin password of the database.
tdePassword: string

Password used for password protected software keystore

{
    "type":"object",
    "required":[
        "sysPassword",
        "backupReportDetails",
        "sourceDetails"
    ],
    "properties":{
        "backupReportDetails":{
            "$ref":"#/definitions/DbSystemCreateRestoreBackupReportDetails"
        },
        "sourceDetails":{
            "$ref":"#/definitions/DbSystemCreateRestoreBackupSourceDetails"
        },
        "customization":{
            "$ref":"#/definitions/DbSystemCreateRestoreBackupDatabaseCustomization"
        },
        "sysPassword":{
            "type":"string",
            "description":"Admin password of the database."
        },
        "tdePassword":{
            "type":"string",
            "description":"Password used for password protected software keystore"
        },
        "backupPasswords":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"RMAN backup password used to encrypt backups"
            }
        },
        "numberOfRmanChannels":{
            "type":"integer",
            "description":"Number of RMAN channel that must be used while creating the database from backup"
        },
        "enableForceDelete":{
            "type":"boolean",
            "description":"Deletes the filegroups, FRA and archived logs of database that is getting created from backup, if present"
        }
    }
}

Nested Schema : DbSystemCreateSystemParams

Type: object

Show Source

clusterName: string

Cluster name to assign instead of autogenerated one
cpuPoolName: string

Name of the shared DB System CPU Pool
customMemorySize: string

Memory of the DB System
customRoleSeparation: object DbSystemCreateRoleSeparationParams
diskGroup: string

ASM disk group
enableRoleSeparation: boolean

Whether or not to enable the role separation
failOver: boolean
multiUserAccess: object DbSystemCreateIdmParams
name(required): string

Name of the DB System
redundancy: string

Allowed Values: [ "MIRROR", "HIGH" ]

Redundancy of the VM storage
shape: string

Shape of the DB System (odb2|odb4|odb6|odb8|odb10| odb12|odb16|odb20|odb24|odb28|odb32|odb36|odb42| odb48|odb56|odb64)
singleNode: string
systemPassword(required): string

Password for the DB System
timeZone(required): string

Time zone of the DB System
useReservedCores: boolean

Whether or not to use reserved CPU cores

{
    "type":"object",
    "required":[
        "name",
        "systemPassword",
        "timeZone"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the DB System"
        },
        "shape":{
            "type":"string",
            "description":"Shape of the DB System (odb2|odb4|odb6|odb8|odb10| odb12|odb16|odb20|odb24|odb28|odb32|odb36|odb42| odb48|odb56|odb64)"
        },
        "customMemorySize":{
            "type":"string",
            "description":"Memory of the DB System"
        },
        "cpuPoolName":{
            "type":"string",
            "description":"Name of the shared DB System CPU Pool"
        },
        "useReservedCores":{
            "type":"boolean",
            "description":"Whether or not to use reserved CPU cores"
        },
        "diskGroup":{
            "type":"string",
            "description":"ASM disk group"
        },
        "systemPassword":{
            "type":"string",
            "description":"Password for the DB System"
        },
        "timeZone":{
            "type":"string",
            "description":"Time zone of the DB System"
        },
        "enableRoleSeparation":{
            "type":"boolean",
            "description":"Whether or not to enable the role separation"
        },
        "singleNode":{
            "type":"string"
        },
        "failOver":{
            "type":"boolean"
        },
        "customRoleSeparation":{
            "$ref":"#/definitions/DbSystemCreateRoleSeparationParams"
        },
        "redundancy":{
            "type":"string",
            "description":"Redundancy of the VM storage",
            "enum":[
                "MIRROR",
                "HIGH"
            ]
        },
        "multiUserAccess":{
            "$ref":"#/definitions/DbSystemCreateIdmParams"
        },
        "clusterName":{
            "type":"string",
            "description":"Cluster name to assign instead of autogenerated one"
        }
    }
}

Nested Schema : DbCharacterSet

Type: object

Show Source

characterSet: string
dbLanguage: string
dbTerritory: string
nlsCharacterset: string

{
    "properties":{
        "characterSet":{
            "type":"string"
        },
        "nlsCharacterset":{
            "type":"string"
        },
        "dbTerritory":{
            "type":"string"
        },
        "dbLanguage":{
            "type":"string"
        }
    }
}

Nested Schema : DbSystemClusterInterconnect

Type: object

Show Source

gateway(required): string

gateway address for Cluster Interconnect
interfaceName(required): string

interface for Cluster Interconnect
subnet(required): string

subnet mask for Cluster Interconnect
vlanId(required): string

vlan id for the Cluster Interconnect

{
    "type":"object",
    "required":[
        "vlanId",
        "gateway",
        "subnet",
        "interfaceName"
    ],
    "properties":{
        "vlanId":{
            "type":"string",
            "description":"vlan id for the Cluster Interconnect"
        },
        "gateway":{
            "type":"string",
            "description":"gateway address for Cluster Interconnect"
        },
        "subnet":{
            "type":"string",
            "description":"subnet mask for Cluster Interconnect"
        },
        "interfaceName":{
            "type":"string",
            "description":"interface for Cluster Interconnect"
        }
    }
}

Nested Schema : dnsServers

Type: array

DNS servers of the network

Show Source

Array of: string

{
    "type":"array",
    "description":"DNS servers of the network",
    "items":{
        "type":"string"
    }
}

Nested Schema : nodes

Type: array

Show Source

Array of: object DbSystemCreateNetworkNodeParams

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DbSystemCreateNetworkNodeParams"
    }
}

Nested Schema : ntpServers

Type: array

NTP servers of the network

Show Source

Array of: string

{
    "type":"array",
    "description":"NTP servers of the network",
    "items":{
        "type":"string"
    }
}

Nested Schema : scanIps

Type: array

SCAN IPs for the DB system database

Show Source

Array of: string

{
    "type":"array",
    "description":"SCAN IPs for the DB system database",
    "items":{
        "type":"string"
    }
}

Nested Schema : DbSystemCreateNetworkNodeParams

Type: object

Show Source

gateway(required): string

Gateway of the DB system node
ipAddress(required): string

IP address of the DB system node
name(required): string

Name of the DB system node
netmask(required): string

Netmask of the DB system node
number(required): integer

Number of the DB system node
vipAddress: string

Virtual IP address of the DB system node
vipName: string

Virtual IP name of the DB system node

{
    "type":"object",
    "required":[
        "number",
        "name",
        "ipAddress",
        "netmask",
        "gateway"
    ],
    "properties":{
        "number":{
            "type":"integer",
            "description":"Number of the DB system node"
        },
        "name":{
            "type":"string",
            "description":"Name of the DB system node"
        },
        "ipAddress":{
            "type":"string",
            "description":"IP address of the DB system node"
        },
        "netmask":{
            "type":"string",
            "description":"Netmask of the DB system node"
        },
        "gateway":{
            "type":"string",
            "description":"Gateway of the DB system node"
        },
        "vipName":{
            "type":"string",
            "description":"Virtual IP name of the DB system node"
        },
        "vipAddress":{
            "type":"string",
            "description":"Virtual IP address of the DB system node"
        }
    }
}

Nested Schema : backupPasswords

Type: array

Show Source

Array of: string

RMAN backup password used to encrypt backups

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"RMAN backup password used to encrypt backups"
    }
}

Nested Schema : DbSystemCreateRestoreBackupReportDetails

Type: object

Details of the backup report that must be used to restore the database within a new DB System

Show Source

backupReport: object BackupReport
backupReportId: string

ODA resource ID of the backup report
backupReportPath: string

Path of the backup report JSON file present in local Bare Metal

{
    "type":"object",
    "description":"Details of the backup report that must be used to restore the database within a new DB System",
    "properties":{
        "backupReportId":{
            "type":"string",
            "description":"ODA resource ID of the backup report"
        },
        "backupReportPath":{
            "type":"string",
            "description":"Path of the backup report JSON file present in local Bare Metal"
        },
        "backupReport":{
            "$ref":"#/definitions/BackupReport"
        }
    }
}

Nested Schema : DbSystemCreateRestoreBackupDatabaseCustomization

Type: object

Database parameters that can be customized for restored database within a new DB System

Show Source

backupLocation: string

Database backup location
dbClass: string

Class of the database (OLTP|DSS|IMDB)
dbConsoleEnable: boolean

Whether or not the database console is enabled
dbDomainName: string

Domain name of the database
dbEdition: string

Edition of the database (SE|EE)
dbName: string

Name of the database
dbRedundancy: string

Redundancy of the database
dbShape: string

Shape of the database (odb1s|odb1|odb2|odb4|odb6| odb8|odb10|odb12|odb16|odb20|odb24|odb28|odb32| odb36|odb42|odb48|odb56|odb64)
dbType: string

Type of the database (RAC|RACOne|SI)
dbUniqueName: string

Unique name of the database
enableEEHA: boolean

Enable HA for EE SI database
enableSEHA: boolean

Enable HA for SE for 19c and later SI database
tdeFilesLocation: string

TDE wallet backup location

{
    "type":"object",
    "description":"Database parameters that can be customized for restored database within a new DB System",
    "properties":{
        "dbName":{
            "type":"string",
            "description":"Name of the database"
        },
        "dbUniqueName":{
            "type":"string",
            "description":"Unique name of the database"
        },
        "dbClass":{
            "type":"string",
            "description":"Class of the database (OLTP|DSS|IMDB)"
        },
        "dbType":{
            "type":"string",
            "description":"Type of the database (RAC|RACOne|SI)"
        },
        "dbEdition":{
            "type":"string",
            "description":"Edition of the database (SE|EE)"
        },
        "dbRedundancy":{
            "type":"string",
            "description":"Redundancy of the database"
        },
        "dbDomainName":{
            "type":"string",
            "description":"Domain name of the database"
        },
        "dbShape":{
            "type":"string",
            "description":"Shape of the database (odb1s|odb1|odb2|odb4|odb6| odb8|odb10|odb12|odb16|odb20|odb24|odb28|odb32| odb36|odb42|odb48|odb56|odb64)"
        },
        "dbConsoleEnable":{
            "type":"boolean",
            "description":"Whether or not the database console is enabled"
        },
        "enableSEHA":{
            "description":"Enable HA for SE for 19c and later SI database",
            "type":"boolean"
        },
        "enableEEHA":{
            "description":"Enable HA for EE SI database",
            "type":"boolean"
        },
        "backupLocation":{
            "type":"string",
            "description":"Database backup location"
        },
        "tdeFilesLocation":{
            "type":"string",
            "description":"TDE wallet backup location"
        }
    }
}

Nested Schema : DbSystemCreateRestoreBackupSourceDetails

Type: object

Details of the backup and its destination

Show Source

nfsDetails: object DbSystemCreateRestoreBackupNfsDetails

Details to NFS location where backups are present
objectStoreDetails: object DbSystemCreateRestoreBackupObjectStoreDetails

Details of the Object Store where backups are present
rmanBackupEncrypted: boolean

Flag to indicate backups are encrypted by RMAN.
tdeEnabled: boolean

Flag to indicate backups are encryted using TDE enabled

{
    "type":"object",
    "description":"Details of the backup and its destination",
    "properties":{
        "objectStoreDetails":{
            "$ref":"#/definitions/DbSystemCreateRestoreBackupObjectStoreDetails"
        },
        "nfsDetails":{
            "$ref":"#/definitions/DbSystemCreateRestoreBackupNfsDetails"
        },
        "tdeEnabled":{
            "type":"boolean",
            "description":"Flag to indicate backups are encryted using TDE enabled"
        },
        "rmanBackupEncrypted":{
            "type":"boolean",
            "description":"Flag to indicate backups are encrypted by RMAN."
        }
    }
}

Nested Schema : BackupReport

Type: object

Show Source

backupLocation: string
backupLogLoc: string
backupReportLogDetail: string
backupType: string
cfBackupHandle: string
compressionAlgo: string

The RMAN compression algorithm that the database is configured.
cpuPool: string

Defines the CPU Pool name
createTime: string(date-time)
dbConfigLoc: string
dbDataSize: string
dbId: string
dbInfo: object DbInfo
dbName: string
dbRedoSize: string
dbResId: string
dbUniqueName: string
id: string
keepDays: integer
keystoreType: string

Type of keystore, which stores TDE Master Encryption Key. Either Software or OKV.
name: string

display name for the resource
numberOfCores: integer

Defines the number of cores
oraHomeVersion: string
pitrSCN: string
pitrTimeStamp: string(date-time)
resetLogsSCN: string
resetLogsTimeStamp: string(date-time)
rmanBackupPieces: string
spfBackupHandle: string
sqlPatches: string
state: object ResourceState
tag: string
tdeWalletLoc: string
updatedTime: string(date-time)

{
    "properties":{
        "id":{
            "type":"string"
        },
        "dbResId":{
            "type":"string"
        },
        "tag":{
            "type":"string"
        },
        "dbId":{
            "type":"string"
        },
        "dbName":{
            "type":"string"
        },
        "dbUniqueName":{
            "type":"string"
        },
        "backupType":{
            "type":"string"
        },
        "keepDays":{
            "type":"integer"
        },
        "backupLocation":{
            "type":"string"
        },
        "cfBackupHandle":{
            "type":"string"
        },
        "spfBackupHandle":{
            "type":"string"
        },
        "pitrTimeStamp":{
            "type":"string",
            "format":"date-time"
        },
        "pitrSCN":{
            "type":"string"
        },
        "resetLogsTimeStamp":{
            "type":"string",
            "format":"date-time"
        },
        "resetLogsSCN":{
            "type":"string"
        },
        "oraHomeVersion":{
            "type":"string"
        },
        "sqlPatches":{
            "type":"string"
        },
        "backupLogLoc":{
            "type":"string"
        },
        "tdeWalletLoc":{
            "type":"string"
        },
        "dbConfigLoc":{
            "type":"string"
        },
        "name":{
            "description":"display name for the resource",
            "type":"string"
        },
        "createTime":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "$ref":"#/definitions/ResourceState"
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        },
        "backupReportLogDetail":{
            "type":"string"
        },
        "dbInfo":{
            "$ref":"#/definitions/DbInfo"
        },
        "dbDataSize":{
            "type":"string"
        },
        "dbRedoSize":{
            "type":"string"
        },
        "rmanBackupPieces":{
            "type":"string"
        },
        "compressionAlgo":{
            "type":"string",
            "description":"The RMAN compression algorithm that the database is configured."
        },
        "cpuPool":{
            "description":"Defines the CPU Pool name",
            "type":"string"
        },
        "numberOfCores":{
            "description":"Defines the number of cores",
            "type":"integer"
        },
        "keystoreType":{
            "description":"Type of keystore, which stores TDE Master Encryption Key. Either Software or OKV.",
            "type":"string"
        }
    }
}

Nested Schema : DbInfo

Type: object

Show Source

dbClass: string
dbEdition: string
dbRedundancy: string
dbShape: string
dbStorage: string
dbType: string
isCdb: boolean
pdbName: string

{
    "properties":{
        "dbClass":{
            "type":"string"
        },
        "dbType":{
            "type":"string"
        },
        "dbShape":{
            "type":"string"
        },
        "dbEdition":{
            "type":"string"
        },
        "dbStorage":{
            "type":"string"
        },
        "dbRedundancy":{
            "type":"string"
        },
        "pdbName":{
            "type":"string"
        },
        "isCdb":{
            "type":"boolean"
        }
    }
}

Nested Schema : ResourceState

Type: object

Show Source

status: string

Allowed Values: [ "CREATING", "CONFIGURED", "UPDATING", "DELETING", "FAILED", "RUNNING", "ENABLED", "DISABLED", "STALE" ]

{
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "CREATING",
                "CONFIGURED",
                "UPDATING",
                "DELETING",
                "FAILED",
                "RUNNING",
                "ENABLED",
                "DISABLED",
                "STALE"
            ]
        }
    }
}

Nested Schema : DbSystemCreateRestoreBackupNfsDetails

Type: object

Details to NFS location where backups are present

Show Source

serverIP(required): string

IP address of the machine where NFS server location is available
serverLocation(required): string

NFS server location

{
    "description":"Details to NFS location where backups are present",
    "required":[
        "serverIP",
        "serverLocation"
    ],
    "properties":{
        "serverIP":{
            "description":"IP address of the machine where NFS server location is available",
            "type":"string"
        },
        "serverLocation":{
            "description":"NFS server location",
            "type":"string"
        }
    }
}

Nested Schema : DbSystemCreateRestoreBackupObjectStoreDetails

Type: object

Details of the Object Store where backups are present

Show Source

endPointURL: string

Object Store end point URL
objectStoreSwiftName(required): string

Name of the Object Store Swift object
password: string

Object Store password
tenantName: string

Name of the Object Store tenancy
userName: string

Object Store user name

{
    "description":"Details of the Object Store where backups are present",
    "required":[
        "objectStoreSwiftName"
    ],
    "properties":{
        "objectStoreSwiftName":{
            "description":"Name of the Object Store Swift object",
            "type":"string"
        },
        "tenantName":{
            "description":"Name of the Object Store tenancy",
            "type":"string"
        },
        "userName":{
            "description":"Object Store user name",
            "type":"string"
        },
        "endPointURL":{
            "description":"Object Store end point URL",
            "type":"string"
        },
        "password":{
            "description":"Object Store password",
            "type":"string"
        }
    }
}

Nested Schema : DbSystemCreateRoleSeparationParams

Type: object

Show Source

groups(required): array groups
users(required): array users

{
    "type":"object",
    "required":[
        "groups",
        "users"
    ],
    "properties":{
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemCreateGroupParams"
            }
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemCreateUserParams"
            }
        }
    }
}

Nested Schema : DbSystemCreateIdmParams

Type: object

Show Source

configurations: object DbSystemCreateIdmConfigurationsParams
isMultiUserAccessEnabled: boolean

Set this flag to true to enable multi user access on this environment.
isMultiUserAccessPLEnabled: boolean

Set this flag to true to enable passwordless multi user access on this environment.
userCredentials: object DbSystemCreateIdmUserCredentialsParams

{
    "properties":{
        "isMultiUserAccessEnabled":{
            "type":"boolean",
            "description":"Set this flag to true to enable multi user access on this environment."
        },
        "isMultiUserAccessPLEnabled":{
            "type":"boolean",
            "description":"Set this flag to true to enable passwordless multi user access on this environment."
        },
        "userCredentials":{
            "$ref":"#/definitions/DbSystemCreateIdmUserCredentialsParams"
        },
        "configurations":{
            "$ref":"#/definitions/DbSystemCreateIdmConfigurationsParams"
        }
    }
}

Nested Schema : groups

Type: array

Show Source

Array of: object DbSystemCreateGroupParams

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DbSystemCreateGroupParams"
    }
}

Nested Schema : users

Type: array

Show Source

Array of: object DbSystemCreateUserParams

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DbSystemCreateUserParams"
    }
}

Nested Schema : DbSystemCreateGroupParams

Type: object

Show Source

id(required): integer

ID for the group
name(required): string

Name for the group
role(required): string

Role for the group

{
    "type":"object",
    "required":[
        "id",
        "name",
        "role"
    ],
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID for the group"
        },
        "name":{
            "type":"string",
            "description":"Name for the group"
        },
        "role":{
            "type":"string",
            "description":"Role for the group"
        }
    }
}

Nested Schema : DbSystemCreateUserParams

Type: object

Show Source

id(required): integer

ID for the user
name(required): string

Name for the user
role(required): string

Role for the user

{
    "type":"object",
    "required":[
        "id",
        "name",
        "role"
    ],
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID for the user"
        },
        "name":{
            "type":"string",
            "description":"Name for the user"
        },
        "role":{
            "type":"string",
            "description":"Role for the user"
        }
    }
}

Nested Schema : DbSystemCreateIdmConfigurationsParams

Type: object

Show Source

dcsUserPasswdExpDurationInDays: integer

Password expiry duration in days for DCS user
maxNumFailedLoginAttempts: integer

Max number of failed login attempts allowed after which the user account gets locked
metadataStoreName: string

Persistent Store for the IDM service provider
passwordResetDurationInMins: integer

Time duration in minutes in which password needs to be reset for a locked account
providerName: string

Name of the IDM service provider
tokenExpirationInMins: integer

Auth Token expiration duration in minutes

{
    "type":"object",
    "properties":{
        "providerName":{
            "type":"string",
            "description":"Name of the IDM service provider"
        },
        "metadataStoreName":{
            "type":"string",
            "description":"Persistent Store for the IDM service provider"
        },
        "dcsUserPasswdExpDurationInDays":{
            "type":"integer",
            "description":"Password expiry duration in days for DCS user"
        },
        "tokenExpirationInMins":{
            "type":"integer",
            "description":"Auth Token expiration duration in minutes"
        },
        "maxNumFailedLoginAttempts":{
            "type":"integer",
            "description":"Max number of failed login attempts allowed after which the user account gets locked"
        },
        "passwordResetDurationInMins":{
            "type":"integer",
            "description":"Time duration in minutes in which password needs to be reset for a locked account"
        }
    }
}

Nested Schema : DbSystemCreateIdmUserCredentialsParams

Type: object

Show Source

gridUserPasswd: string

Password for the system user with gridUser role
odaadminUserPasswd: string

Password for the system user with ODA-ADMINISTRATOR role
oracleUserPasswd: string

Password for the system user with oracleUser role

{
    "type":"object",
    "properties":{
        "oracleUserPasswd":{
            "type":"string",
            "description":"Password for the system user with oracleUser role"
        },
        "gridUserPasswd":{
            "type":"string",
            "description":"Password for the system user with gridUser role"
        },
        "odaadminUserPasswd":{
            "type":"string",
            "description":"Password for the system user with ODA-ADMINISTRATOR role"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : KvmJob

Type: object

Show Source

jobId: string
jobReport: object ServiceJobReport

Job Request Status
syncJob: boolean

{
    "type":"object",
    "properties":{
        "syncJob":{
            "type":"boolean"
        },
        "jobId":{
            "type":"string"
        },
        "jobReport":{
            "$ref":"#/definitions/ServiceJobReport"
        }
    }
}

Nested Schema : ServiceJobReport

Type: object

Job Request Status

Show Source

cpsMetadata: string
createTimestamp: string(date-time)
description: string
jobId: string
jobType: string
message: string
reports: array reports
resourceList: array resourceList
status: string

Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]
updatedTime: string(date-time)

{
    "description":"Job Request Status",
    "properties":{
        "jobId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure"
            ]
        },
        "message":{
            "type":"string"
        },
        "reports":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskReport"
            }
        },
        "createTimestamp":{
            "type":"string",
            "format":"date-time"
        },
        "resourceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/JobResourceInfo"
            }
        },
        "description":{
            "type":"string"
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        },
        "jobType":{
            "type":"string"
        },
        "cpsMetadata":{
            "type":"string"
        }
    }
}

Nested Schema : reports

Type: array

Show Source

Array of: object TaskReport

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaskReport"
    }
}

Nested Schema : resourceList

Type: array

Show Source

Array of: object JobResourceInfo

resource information

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/JobResourceInfo"
    }
}

Nested Schema : TaskReport

Type: object

Show Source

duration: string
endTime: string(date-time)
jobId: string
nodeName: string
parentTaskId: string
reportLevel: string

Allowed Values: [ "Verbose", "Info", "Error" ]
startTime: string(date-time)
status: string

Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "Skipped" ]
tags: array tags
taskDescription: string
taskId: string
taskName: string
taskResult: string
updatedTime: string(date-time)

{
    "properties":{
        "taskId":{
            "type":"string"
        },
        "taskName":{
            "type":"string"
        },
        "nodeName":{
            "type":"string"
        },
        "taskResult":{
            "type":"string"
        },
        "startTime":{
            "type":"string",
            "format":"date-time"
        },
        "endTime":{
            "type":"string",
            "format":"date-time"
        },
        "duration":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure",
                "Skipped"
            ]
        },
        "taskDescription":{
            "type":"string"
        },
        "parentTaskId":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reportLevel":{
            "type":"string",
            "enum":[
                "Verbose",
                "Info",
                "Error"
            ]
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : tags

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : JobResourceInfo

Type: object

resource information

Show Source

jobId: string
resourceId: string
resourceNewType: string
resourceType: string

Allowed Values: [ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Pdb", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]
updatedTime: string(date-time)

{
    "description":"resource information",
    "properties":{
        "resourceId":{
            "type":"string"
        },
        "resourceType":{
            "type":"string",
            "enum":[
                "Backup",
                "BackupConfig",
                "DB",
                "DbHome",
                "Grid",
                "Pdb",
                "Recovery",
                "Report",
                "Tde",
                "ObjectStoreSwift"
            ]
        },
        "resourceNewType":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Default Response

An unexpected error has occurred

Root Schema : Error

Type: object

Show Source

code(required): string
message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}