Jump to

• Request
• Response

Create KVM Database System

post

/dbsystem

Create a new KVM Database 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

Body ()

Parameters to create a DB System

Root Schema : DbSystemCreateParams

Type: object

Show Source

• database(optional): object DbSystemCreateDatabaseParams
• dbHome(optional): object DbSystemCreateDbHomeParams
• forced(optional): boolean
  Whether or not to force the DB System create operation
• grid(optional): object DbSystemCreateGridParams
• network: object DbSystemCreateNetworkParams
• restoreDatabase(optional): object DbSystemCreateRestoreDatabaseParams
• system: object DbSystemCreateSystemParams

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

Nested Schema : DbSystemCreateDatabaseParams

Type: object

Show Source

• adminPassword: string
  Admin password of the database
• characterSet(optional): object DbCharacterSet
• dbClass: string
  Allowed Values: [ "OLTP", "DSS", "IMDB" ]

  Class of the database (OLTP|DSS|IMDB)
• dbStorage(optional): string
  Allowed Values: [ "ASM", "PMEM" ]

  Storage type of the database (ASM|PMEM) - The default value is ASM
• domainName: string
  Domain name of the database
• edition: string
  Allowed Values: [ "SE", "EE" ]

  Edition of the database (SE|EE)
• enableDbConsole(optional): boolean
  Whether or not the database console is enabled
• enableEEHA(optional): boolean
  Whether or not to enable HA for EE SI database
• enableFlashCache(optional): boolean
  Whether or not enable flash cache
• enableFlashStorage(optional): boolean
  Whether or not enable flash storage
• enableSEHA(optional): boolean
  Whether or not to enable HA for SE for 19c and later SI database
• enableTDE(optional): boolean
  Whether or not enable TDE
• enableUnifiedAuditing(optional): boolean
  Whether or not enable unified auditing
• isCdb(optional): boolean
  Whether or not the database is CDB
• level0BackupDay(optional): string
  Allowed Values: [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]

  Backup day of the database (monday|tuesday|wednesday|thursday|friday|saturday|sunday)
• name: string
  Name of the database
• pdbAdminUser(optional): string
  Name of the PDB admin user
• pdbName(optional): string
  Name of the PDB
• redundancy(optional): 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(optional): string
  RMAN backup password of the database
• role: string
  Allowed Values: [ "PRIMARY", "STANDBY" ]

  Role of the database (PRIMARY|STANDBY)
• shape: string
  Allowed Values: [ "odb2", "odb4", "odb6", "odb8", "odb10", "odb12", "odb16", "odb20", "odb24", "odb28", "odb32", "odb36", "odb42", "odb48", "odb56", "odb64" ]

  Shape of the database (odb2|odb4|odb6|odb8|odb10| odb12|odb16|odb20|odb24|odb28|odb32|odb36|odb42| odb48|odb56|odb64)
• targetNodeNumber(optional): integer
  Target node number of the database
• tdePassword(optional): string
  TDE password of the database
• type: string
  Allowed Values: [ "RAC", "RACOne", "SI" ]

  Type of the database (RAC|RACOne|SI)
• uniqueName: string
  Unique name of the database
• version: 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 (odb2|odb4|odb6|odb8|odb10| odb12|odb16|odb20|odb24|odb28|odb32|odb36|odb42| odb48|odb56|odb64)",
            "enum":[
                "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"
        },
        "targetNodeNumber":{
            "type":"integer",
            "description":"Target node number 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(optional): string
  Allowed Values: [ "SE", "EE" ]

  Edition of the database home (SE|EE)
• enableUnifiedAuditing(optional): boolean
  Whether or not enable unified auditing
• version: 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(optional): boolean
  Whether or not AFD is enabled within DB system
• language(optional): string
  Language setting for the grid installation
• version(optional): 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(optional): object DbSystemClusterInterconnect
• dnsServers: array dnsServers
  DNS servers of the network
• domainName: string
  Domain name of the network
• nodes: array nodes
• ntpServers: array ntpServers
  NTP servers of the network
• publicVNetwork(optional): string
  Name of the public virtual network
• scanIps(optional): array scanIps
  SCAN IPs for the DB system database
• scanName(optional): 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(optional): array backupPasswords
• backupReportDetails: object DbSystemCreateRestoreBackupReportDetails
  Details of the backup report that must be used to restore the database within a new DB System
• customization(optional): object DbSystemCreateRestoreBackupDatabaseCustomization
  Database parameters that can be customized for restored database within a new DB System
• enableForceDelete(optional): boolean
  Deletes the filegroups, FRA and archived logs of database that is getting created from backup, if present
• numberOfRmanChannels(optional): integer
  Number of RMAN channel that must be used while creating the database from backup
• sourceDetails: object DbSystemCreateRestoreBackupSourceDetails
  Details of the backup and its destination
• sysPassword: string
  Admin password of the database.
• tdePassword(optional): 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

• cpuPoolName(optional): string
  Name of the shared DB System CPU Pool
• customMemorySize(optional): string
  Memory of the DB System
• customRoleSeparation(optional): object DbSystemCreateRoleSeparationParams
• diskGroup(optional): string
  ASM disk group
• enableRoleSeparation(optional): boolean
  Whether or not to enable the role separation
• failOver(optional): boolean
• name: string
  Name of the DB System
• redundancy(optional): string
  Allowed Values: [ "MIRROR", "HIGH" ]

  Redundancy of the VM storage
• shape(optional): string
  Shape of the DB System (odb2|odb4|odb6|odb8|odb10| odb12|odb16|odb20|odb24|odb28|odb32|odb36|odb42| odb48|odb56|odb64)
• singleNode(optional): string
• systemPassword: string
  Password for the DB System
• timeZone: string
  Time zone of the DB System
• useReservedCores(optional): 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"
            ]
        }
    }
}

Nested Schema : DbCharacterSet

Type: object

Show Source

• characterSet(optional): string
• dbLanguage(optional): string
• dbTerritory(optional): string
• nlsCharacterset(optional): string

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

Nested Schema : DbSystemClusterInterconnect

Type: object

Show Source

• gateway: string
  gateway address for Cluster Interconnect
• interfaceName: string
  interface for Cluster Interconnect
• subnet: string
  subnet mask for Cluster Interconnect
• vlanId: 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: string
  Gateway of the DB system node
• ipAddress: string
  IP address of the DB system node
• name: string
  Name of the DB system node
• netmask: string
  Netmask of the DB system node
• number: integer
  Number of the DB system node
• vipAddress(optional): string
  Virtual IP address of the DB system node
• vipName(optional): 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(optional): object BackupReport
• backupReportId(optional): string
  ODA resource ID of the backup report
• backupReportPath(optional): 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(optional): string
  Database backup location
• dbClass(optional): string
  Class of the database (OLTP|DSS|IMDB)
• dbConsoleEnable(optional): boolean
  Whether or not the database console is enabled
• dbDomainName(optional): string
  Domain name of the database
• dbEdition(optional): string
  Edition of the database (SE|EE)
• dbName(optional): string
  Name of the database
• dbRedundancy(optional): string
  Redundancy of the database
• dbShape(optional): string
  Shape of the database (odb2|odb4|odb6|odb8|odb10| odb12|odb16|odb20|odb24|odb28|odb32|odb36|odb42| odb48|odb56|odb64)
• dbType(optional): string
  Type of the database (RAC|RACOne|SI)
• dbUniqueName(optional): string
  Unique name of the database
• enableEEHA(optional): boolean
  Enable HA for EE SI database
• enableSEHA(optional): boolean
  Enable HA for SE for 19c and later SI database
• tdeFilesLocation(optional): 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 (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(optional): object DbSystemCreateRestoreBackupNfsDetails
  Details to NFS location where backups are present
• objectStoreDetails(optional): object DbSystemCreateRestoreBackupObjectStoreDetails
  Details of the Object Store where backups are present
• rmanBackupEncrypted(optional): boolean
  Flag to indicate backups are encrypted by RMAN.
• tdeEnabled(optional): 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(optional): string
• backupLogLoc(optional): string
• backupReportLogDetail(optional): string
• backupType(optional): string
• cfBackupHandle(optional): string
• compressionAlgo(optional): string
  The RMAN compression algorithm that the database is configured.
• cpuPool(optional): string
  Defines the CPU Pool name
• createTime(optional): string(date-time)
• dbConfigLoc(optional): string
• dbDataSize(optional): string
• dbId(optional): string
• dbInfo(optional): object DbInfo
• dbName(optional): string
• dbRedoSize(optional): string
• dbResId(optional): string
• dbUniqueName(optional): string
• id(optional): string
• keepDays(optional): integer
• name(optional): string
  display name for the resource
• numberOfCores(optional): integer
  Defines the number of cores
• oraHomeVersion(optional): string
• pitrSCN(optional): string
• pitrTimeStamp(optional): string(date-time)
• resetLogsSCN(optional): string
• resetLogsTimeStamp(optional): string(date-time)
• rmanBackupPieces(optional): string
• spfBackupHandle(optional): string
• sqlPatches(optional): string
• state(optional): object ResourceState
• tag(optional): string
• tdeWalletLoc(optional): string
• updatedTime(optional): 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"
        }
    }
}

Nested Schema : DbInfo

Type: object

Show Source

• dbClass(optional): string
• dbEdition(optional): string
• dbRedundancy(optional): string
• dbShape(optional): string
• dbStorage(optional): string
• dbType(optional): string
• isCdb(optional): boolean
• pdbName(optional): 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(optional): 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: string
  IP address of the machine where NFS server location is available
• serverLocation: 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(optional): string
  Object Store end point URL
• objectStoreSwiftName: string
  Name of the Object Store Swift object
• password(optional): string
  Object Store password
• tenantName(optional): string
  Name of the Object Store tenancy
• userName(optional): 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: array groups
• users: array users

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

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: integer
  ID for the group
• name: string
  Name for the group
• role: 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: integer
  ID for the user
• name: string
  Name for the user
• role: 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : KvmJob

Type: object

Show Source

• jobId(optional): string
• jobReport(optional): object ServiceJobReport
  Job Request Status
• syncJob(optional): boolean

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

Nested Schema : ServiceJobReport

Type: object

Job Request Status

Show Source

• createTimestamp(optional): string(date-time)
• description(optional): string
• jobId(optional): string
• jobType(optional): string
• message(optional): string
• reports(optional): array reports
• resourceList(optional): array resourceList
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]
• updatedTime(optional): 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"
        }
    }
}

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(optional): string
• endTime(optional): string(date-time)
• jobId(optional): string
• nodeName(optional): string
• parentTaskId(optional): string
• reportLevel(optional): string
  Allowed Values: [ "Verbose", "Info", "Error" ]
• startTime(optional): string(date-time)
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "Skipped" ]
• tags(optional): array tags
• taskDescription(optional): string
• taskId(optional): string
• taskName(optional): string
• taskResult(optional): string
• updatedTime(optional): 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(optional): string
• resourceId(optional): string
• resourceNewType(optional): string
• resourceType(optional): string
  Allowed Values: [ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Pdb", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]
• updatedTime(optional): 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

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
• message: string

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

Back to Top