Jump to

• Request
• Response

Get all the KVM DB systems

get

/dbsystem

present in the system.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DbSystem

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

Nested Schema : DbSystem

Type: object

Show Source

• afdEnabled: boolean
• clusterName: string
• cpuPool: object DbSystemCpuPool
• createTime: string(date-time)
• databases: array databases
• freeformTags: string
• gridHome: object DbSystemGridHome
• id: string
• image: string
• memorySizeFormatted: string
• memorySizeInMb: integer
• name: string
• numaEnabled: boolean
• numberOfCores: integer
• shapeName: string
• state: string
• storage: object DbSystemStorage
• updateTime: string(date-time)
• version: string
• vms: array vms

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "createTime":{
            "type":"string",
            "format":"date-time"
        },
        "updateTime":{
            "type":"string",
            "format":"date-time"
        },
        "image":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "shapeName":{
            "type":"string"
        },
        "clusterName":{
            "type":"string"
        },
        "numberOfCores":{
            "type":"integer"
        },
        "memorySizeInMb":{
            "type":"integer"
        },
        "memorySizeFormatted":{
            "type":"string"
        },
        "numaEnabled":{
            "type":"boolean"
        },
        "afdEnabled":{
            "type":"boolean"
        },
        "freeformTags":{
            "type":"string"
        },
        "storage":{
            "$ref":"#/definitions/DbSystemStorage"
        },
        "cpuPool":{
            "$ref":"#/definitions/DbSystemCpuPool"
        },
        "vms":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemVm"
            }
        },
        "databases":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DB"
            }
        },
        "gridHome":{
            "$ref":"#/definitions/DbSystemGridHome"
        }
    }
}

Nested Schema : DbSystemCpuPool

Type: object

Show Source

• name: string
• numberOfCores: integer
• perNodeAllocations: array perNodeAllocations
• type: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "numberOfCores":{
            "type":"integer"
        },
        "perNodeAllocations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CpuPoolNodeAllocation"
            }
        }
    }
}

Nested Schema : databases

Type: array

Show Source

• Array of: object DB

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

Nested Schema : DbSystemGridHome

Type: object

Show Source

• location: string
• name: string
• version: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Nested Schema : DbSystemStorage

Type: object

Show Source

• accVolumeDevice: string
• accVolumeName: string
• accVolumeSizeFormatted: string
• accVolumeSizeInMb: integer(int64)
• diskGroup: string
• hasAccVolume: boolean
• mountPoint: string
• redundancy: string
  Allowed Values: [ "MIRROR", "HIGH", "REBALANCE_IN_PROGRESS", "EXTERNAL", "EXTENDED", "UNAVAILABLE" ]

  Redundancy of the VM storage
• sizeFormatted: string
• sizeInMb: integer(int64)
• volumeDevice: string
• volumeName: string

{
    "type":"object",
    "properties":{
        "diskGroup":{
            "type":"string"
        },
        "volumeName":{
            "type":"string"
        },
        "volumeDevice":{
            "type":"string"
        },
        "sizeInMb":{
            "type":"integer",
            "format":"int64"
        },
        "sizeFormatted":{
            "type":"string"
        },
        "hasAccVolume":{
            "type":"boolean"
        },
        "accVolumeName":{
            "type":"string"
        },
        "accVolumeDevice":{
            "type":"string"
        },
        "accVolumeSizeInMb":{
            "type":"integer",
            "format":"int64"
        },
        "accVolumeSizeFormatted":{
            "type":"string"
        },
        "mountPoint":{
            "type":"string"
        },
        "redundancy":{
            "type":"string",
            "description":"Redundancy of the VM storage",
            "enum":[
                "MIRROR",
                "HIGH",
                "REBALANCE_IN_PROGRESS",
                "EXTERNAL",
                "EXTENDED",
                "UNAVAILABLE"
            ]
        }
    }
}

Nested Schema : vms

Type: array

Show Source

• Array of: object DbSystemVm

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

Nested Schema : perNodeAllocations

Type: array

Show Source

• Array of: object CpuPoolNodeAllocation

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

Nested Schema : CpuPoolNodeAllocation

Type: object

Show Source

• cpus: array cpus
• effectiveCpuSet: string
• nodeName: string

{
    "type":"object",
    "properties":{
        "nodeName":{
            "type":"string"
        },
        "effectiveCpuSet":{
            "type":"string"
        },
        "cpus":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PhysicalCpu"
            }
        }
    }
}

Nested Schema : cpus

Type: array

Show Source

• Array of: object PhysicalCpu

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

Nested Schema : PhysicalCpu

Type: object

Show Source

• cpuId: integer
• online: boolean

{
    "type":"object",
    "properties":{
        "cpuId":{
            "type":"integer"
        },
        "online":{
            "type":"boolean"
        }
    }
}

Nested Schema : DB

Type: object

Show Source

• associatedNetworks: array associatedNetworks
• backupConfigId: string
• cloudStorageContainer: string
  if the object store backup is selected, then which container should the database backup go to.
• cpupool: string
  Defines the CPU Pool name
• createTime: string(date-time)
• databaseUniqueName: string
• dbCharacterSet: object DbCharacterSet
• dbClass: string
  Allowed Values: [ "OLTP", "DSS", "IMDB" ]
• dbConsoleEnable: boolean
• dbDomainName: string
• dbEdition: string
  Database Edition.
• dbHomeId: string
  The database home resource identifier for associating this database.
• dbId: string
  The database id
• dbName: string
• dbRedundancy: string
• dbRole: string
  Database role (PRIMARY/STANDBY).
• dbShape: string
  Allowed Values: [ "odb1s", "odb1", "odb2", "odb4", "odb6", "odb8", "odb10", "odb12", "odb16", "odb20", "odb24", "odb28", "odb32", "odb36", "odb42", "odb48", "odb56", "odb64" ]
• dbStorage: string
  Allowed Values: [ "ASM", "ACFS", "PMEM" ]
• dbTargetNodeName: string
• dbTargetNodeNumber: string
• dbType: string
  Allowed Values: [ "RAC", "RACOne", "SI" ]
• dbVersion: string
• enableEEHA: boolean
  Enable HA for EE SI database
• enableSEHA: boolean
• enableTDE: boolean
  Flag to create TDE enabled database
• entitySource: string
  Where the database is created. Null for local system.
• id: string
• instanceOnly: boolean
  do not create the database files. Used in case of standby case to create standby instance.
• isAutoBackupDisabled: boolean
• isBcfgInSync: boolean
• isCdb: boolean
• keystoreType: string
  Type of keystore, which stores TDE Master Encryption Key. Either Software or OKV. Default is Software
• level0BackupDay: string
  Allowed Values: [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]
• name: string
  display name for the resource
• okvServerConfigName: string
  Name of the OKV Server Config object which represents the metadata of OKV server where TDE Master Encryption Keys are stored
• okvWalletName: string
  Name of the wallet created for the database in the OKV server. Only applicable for TDE enabled database that uses OKV.
• pdbAdminUserName: string
• pdBName: string
• pdbs: array pdbs
  List of PDB objects that are present in the CDB
• quota: string
  disk space quota for a database.
• registerOnly: boolean
  Use to migrate existing database
• remark: string
  Remark for database status
• rmanBkupPassword: string
• state: object ResourceState
• tdePassword: string
  Password for Password Protected KeyStore
• tdeWalletManagement: string
  Specify wallet management method for TDE enabled database. Allowed values are ODA and EXTERNAL.
• updatedTime: string(date-time)

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "description":"display name for the resource",
            "type":"string"
        },
        "dbName":{
            "type":"string"
        },
        "databaseUniqueName":{
            "type":"string"
        },
        "dbVersion":{
            "type":"string"
        },
        "dbHomeId":{
            "description":"The database home resource identifier for associating this database.",
            "type":"string"
        },
        "instanceOnly":{
            "description":"do not create the database files. Used in case of standby case to create standby instance.",
            "type":"boolean"
        },
        "registerOnly":{
            "description":"Use to migrate existing database",
            "type":"boolean"
        },
        "dbId":{
            "description":"The database id",
            "type":"string"
        },
        "isCdb":{
            "type":"boolean"
        },
        "isAutoBackupDisabled":{
            "type":"boolean"
        },
        "pdBName":{
            "type":"string"
        },
        "pdbAdminUserName":{
            "type":"string"
        },
        "pdbs":{
            "description":"List of PDB objects that are present in the CDB",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Pdb"
            }
        },
        "enableTDE":{
            "type":"boolean",
            "description":"Flag to create TDE enabled database"
        },
        "tdePassword":{
            "description":"Password for Password Protected KeyStore",
            "type":"string"
        },
        "tdeWalletManagement":{
            "description":"Specify wallet management method for TDE enabled database. Allowed values are ODA and EXTERNAL.",
            "type":"string"
        },
        "dbType":{
            "type":"string",
            "enum":[
                "RAC",
                "RACOne",
                "SI"
            ]
        },
        "dbRole":{
            "description":"Database role (PRIMARY/STANDBY).",
            "type":"string"
        },
        "dbTargetNodeNumber":{
            "type":"string"
        },
        "dbClass":{
            "type":"string",
            "enum":[
                "OLTP",
                "DSS",
                "IMDB"
            ]
        },
        "dbShape":{
            "type":"string",
            "enum":[
                "odb1s",
                "odb1",
                "odb2",
                "odb4",
                "odb6",
                "odb8",
                "odb10",
                "odb12",
                "odb16",
                "odb20",
                "odb24",
                "odb28",
                "odb32",
                "odb36",
                "odb42",
                "odb48",
                "odb56",
                "odb64"
            ]
        },
        "dbStorage":{
            "type":"string",
            "enum":[
                "ASM",
                "ACFS",
                "PMEM"
            ]
        },
        "dbRedundancy":{
            "type":"string"
        },
        "quota":{
            "type":"string",
            "description":"disk space quota for a database."
        },
        "dbCharacterSet":{
            "$ref":"#/definitions/DbCharacterSet"
        },
        "dbConsoleEnable":{
            "type":"boolean"
        },
        "backupConfigId":{
            "type":"string"
        },
        "cloudStorageContainer":{
            "type":"string",
            "description":"if the object store backup is selected, then which container should the database backup go to."
        },
        "state":{
            "$ref":"#/definitions/ResourceState"
        },
        "createTime":{
            "type":"string",
            "format":"date-time"
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        },
        "rmanBkupPassword":{
            "type":"string"
        },
        "dbEdition":{
            "description":"Database Edition.",
            "type":"string"
        },
        "dbDomainName":{
            "type":"string"
        },
        "level0BackupDay":{
            "type":"string",
            "enum":[
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday",
                "saturday",
                "sunday"
            ]
        },
        "isBcfgInSync":{
            "type":"boolean"
        },
        "associatedNetworks":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "enableSEHA":{
            "type":"boolean"
        },
        "enableEEHA":{
            "description":"Enable HA for EE SI database",
            "type":"boolean"
        },
        "dbTargetNodeName":{
            "type":"string"
        },
        "cpupool":{
            "description":"Defines the CPU Pool name",
            "type":"string"
        },
        "entitySource":{
            "description":"Where the database is created. Null for local system.",
            "type":"string"
        },
        "remark":{
            "description":"Remark for database status",
            "type":"string"
        },
        "keystoreType":{
            "description":"Type of keystore, which stores TDE Master Encryption Key. Either Software or OKV. Default is Software",
            "type":"string"
        },
        "okvServerConfigName":{
            "description":"Name of the OKV Server Config object which represents the metadata of OKV server where TDE Master Encryption Keys are stored",
            "type":"string"
        },
        "okvWalletName":{
            "type":"string",
            "description":"Name of the wallet created for the database in the OKV server. Only applicable for TDE enabled database that uses OKV."
        }
    }
}

Nested Schema : associatedNetworks

Type: array

Show Source

• Array of: string

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

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 : pdbs

Type: array

List of PDB objects that are present in the CDB

Show Source

• Array of: object Pdb

{
    "description":"List of PDB objects that are present in the CDB",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Pdb"
    }
}

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 : Pdb

Type: object

Show Source

• id: string
  PDB Id
• pdbName: string
  Name of the PDB
• sourcePdbArchivePath: string
  The absolute file name of the PDB archive file if ARCHIVE is used in sourceType
• sourcePdbName: string
  The source PDB name if PDB is used in pdbSource
• sourceType: string
  Allowed Values: [ "SEED", "PDB", "ARCHIVE" ]

  The source type to create the PDB
• state: object ResourceState

{
    "properties":{
        "id":{
            "description":"PDB Id",
            "type":"string"
        },
        "pdbName":{
            "description":"Name of the PDB",
            "type":"string"
        },
        "state":{
            "$ref":"#/definitions/ResourceState"
        },
        "sourceType":{
            "description":"The source type to create the PDB",
            "type":"string",
            "enum":[
                "SEED",
                "PDB",
                "ARCHIVE"
            ]
        },
        "sourcePdbName":{
            "description":"The source PDB name if PDB is used in pdbSource",
            "type":"string"
        },
        "sourcePdbArchivePath":{
            "description":"The absolute file name of the PDB archive file if ARCHIVE is used in sourceType",
            "type":"string"
        }
    }
}

Nested Schema : DbSystemVm

Type: object

Show Source

• customVNetworks: array customVNetworks
• diskImagePath: string
• disks: array disks
• hostName: string
• maxMemoryInMb: string
• name: string
• nodeName: string
• nodeNumber: string
• status: object VmStatus
• vmSnapshotPath: string
• vnetworks: array vnetworks

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "nodeNumber":{
            "type":"string"
        },
        "nodeName":{
            "type":"string"
        },
        "hostName":{
            "type":"string"
        },
        "vmSnapshotPath":{
            "type":"string"
        },
        "diskImagePath":{
            "type":"string"
        },
        "maxMemoryInMb":{
            "type":"string"
        },
        "status":{
            "$ref":"#/definitions/VmStatus"
        },
        "disks":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemDisk"
            }
        },
        "vnetworks":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemVNetwork"
            }
        },
        "customVNetworks":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemCustomVNetwork"
            }
        }
    }
}

Nested Schema : customVNetworks

Type: array

Show Source

• Array of: object DbSystemCustomVNetwork

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

Nested Schema : disks

Type: array

Show Source

• Array of: object DbSystemDisk

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

Nested Schema : VmStatus

Type: object

Show Source

• currNode: string
• currState: string
• targetState: string

{
    "type":"object",
    "properties":{
        "currNode":{
            "type":"string"
        },
        "currState":{
            "type":"string"
        },
        "targetState":{
            "type":"string"
        }
    }
}

Nested Schema : vnetworks

Type: array

Show Source

• Array of: object DbSystemVNetwork

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

Nested Schema : DbSystemCustomVNetwork

Type: object

Show Source

• dbSystemVmName: string
• gateway: string
• ipAddress: string
• macAddress: string
• name: string
• netmask: string
• type: string
• vnetworkName: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "vnetworkName":{
            "type":"string"
        },
        "dbSystemVmName":{
            "type":"string"
        },
        "ipAddress":{
            "type":"string"
        },
        "netmask":{
            "type":"string"
        },
        "gateway":{
            "type":"string"
        },
        "macAddress":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : DbSystemDisk

Type: object

Show Source

• devicePath: string
• name: string
• targetDevice: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "devicePath":{
            "type":"string"
        },
        "targetDevice":{
            "type":"string"
        }
    }
}

Nested Schema : DbSystemVNetwork

Type: object

Show Source

• bridgeName: string
• gateway: string
• ipAddress: string
• name: string
• netmask: string
• targetDevice: string
• type: string
• virtualFunction: string
• vlanName: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "ipAddress":{
            "type":"string"
        },
        "netmask":{
            "type":"string"
        },
        "gateway":{
            "type":"string"
        },
        "targetDevice":{
            "type":"string"
        },
        "virtualFunction":{
            "type":"string"
        },
        "bridgeName":{
            "type":"string"
        },
        "vlanName":{
            "type":"string"
        }
    }
}

Default Response

An unexpected error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

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

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

Back to Top