Jump to

• Request
• Response

Get KVM Database Systems

get

/dbsystem

Get all the KVM Database Systems 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

• clusterName(optional): string
• cpuPool(optional): object DbSystemCpuPool
• createTime(optional): string(date-time)
• databases(optional): array databases
• id(optional): string
• image(optional): string
• memorySizeFormatted(optional): string
• memorySizeInMb(optional): integer
• name(optional): string
• numaEnabled(optional): boolean
• shapeName(optional): string
• state(optional): string
• storage(optional): object DbSystemStorage
• updateTime(optional): string(date-time)
• vms(optional): 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"
        },
        "shapeName":{
            "type":"string"
        },
        "clusterName":{
            "type":"string"
        },
        "memorySizeInMb":{
            "type":"integer"
        },
        "memorySizeFormatted":{
            "type":"string"
        },
        "numaEnabled":{
            "type":"boolean"
        },
        "storage":{
            "$ref":"#/definitions/DbSystemStorage"
        },
        "cpuPool":{
            "$ref":"#/definitions/DbSystemCpuPool"
        },
        "vms":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemVm"
            }
        },
        "databases":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DB"
            }
        }
    }
}

Nested Schema : DbSystemCpuPool

Type: object

Show Source

• name(optional): string
• numberOfCores(optional): integer
• perNodeAllocations(optional): array perNodeAllocations
• type(optional): 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 : DbSystemStorage

Type: object

Show Source

• accVolumeDevice(optional): string
• accVolumeName(optional): string
• accVolumeSizeFormatted(optional): string
• accVolumeSizeInMb(optional): integer(int64)
• diskGroup(optional): string
• hasAccVolume(optional): boolean
• mountPoint(optional): string
• sizeFormatted(optional): string
• sizeInMb(optional): integer(int64)
• volumeDevice(optional): string
• volumeName(optional): 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"
        }
    }
}

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(optional): array cpus
• effectiveCpuSet(optional): string
• nodeName(optional): 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(optional): integer
• online(optional): boolean

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

Nested Schema : DB

Type: object

Show Source

• associatedNetworks(optional): array associatedNetworks
• backupConfigId(optional): string
  Backup Config resource ID
• backupDestination(optional): string
  Allowed Values: [ "NONE", "Disk", "ObjectStore", "Both" ]

  Backup Destination {Disk|ObjectStore|NFS|None}(case-insensitive)
• cloudStorageContainer(optional): string
  if the object store backup is selected, then which container should the database backup go to.
• cpupool(optional): string
  Defines the CPU Pool name
• createTime(optional): string(date-time)
  Database creation timestamp
• databaseUniqueName(optional): string
  Database unique name
• dbCharacterSet(optional): object DbCharacterSet
• dbClass(optional): string
  Allowed Values: [ "OLTP", "DSS", "IMDB" ]

  Database Class EE: OLTP/DSS/IMDB, SE: OLTP (default:OLTP)
• dbConsoleEnable(optional): boolean
  Flag to enable database console
• dbDomainName(optional): string
  Database domain name
• dbEdition(optional): string
  Database Edition
• dbHomeId(optional): string
  The database home resource identifier for associating this database.
• dbId(optional): string
  The database resource ID
• dbName(optional): string
  Database name
• dbRedundancy(optional): string
  Database redundancy
• dbRole(optional): string
  Database role (PRIMARY/STANDBY).
• dbShape(optional): string
  Allowed Values: [ "odb1s", "odb1", "odb2", "odb4", "odb6", "odb8", "odb10", "odb12", "odb16", "odb20", "odb24", "odb28", "odb32", "odb36" ]

  Database Shape{odb1s,odb1,odb2,etc.} (default:odb1)
• dbStorage(optional): string
  Allowed Values: [ "ASM", "ACFS" ]

  Database Storage {ACFS|ASM} (non case-sensitive) (default:ASM) 11.2.0.4 databases can be created only on ACFS storage
• dbTargetNodeName(optional): string
• dbTargetNodeNumber(optional): string
  Target node number
• dbType(optional): string
  Allowed Values: [ "RAC", "RACOne", "SI" ]

  Database Type: SI, RAC, RACOne (default:SI)
• dbVersion(optional): string
  Database version
• enableEEHA(optional): boolean
  Enable HA for EE SI database
• enableSEHA(optional): boolean
• enableTDE(optional): boolean
  Flag to enable Transparent Data Encryption which uses software keystore
• entitySource(optional): string
  Where the database is created. Null for local system.
• id(optional): string
  Database resource ID
• instanceOnly(optional): boolean
  do not create the database files. Used in case of standby case to create standby instance.
• isAutoBackupDisabled(optional): boolean
  Flag to enable or disable auto backup
• isBcfgInSync(optional): boolean
• isCdb(optional): boolean
  Flag to create container database
• level0BackupDay(optional): string
  Allowed Values: [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]
• name(optional): string
  Display name for the database resource
• pdbAdminUserName(optional): string
  Pluggable database admin user name
• pdBName(optional): string
  Pluggable database name
• registerOnly(optional): boolean
  Use to migrate existing database
• rmanBkupPassword(optional): string
  RMAN backup password
• state(optional): object ResourceState
• tdePassword(optional): string
  Password for Password Protected KeyStore
• updatedTime(optional): string(date-time)
  Database last updated timestamp

{
    "properties":{
        "id":{
            "description":"Database resource ID",
            "type":"string"
        },
        "name":{
            "description":"Display name for the database resource",
            "type":"string"
        },
        "dbName":{
            "description":"Database name",
            "type":"string"
        },
        "databaseUniqueName":{
            "description":"Database unique name",
            "type":"string"
        },
        "dbVersion":{
            "description":"Database version",
            "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 resource ID",
            "type":"string"
        },
        "isCdb":{
            "description":"Flag to create container database",
            "type":"boolean"
        },
        "isAutoBackupDisabled":{
            "description":"Flag to enable or disable auto backup",
            "type":"boolean"
        },
        "pdBName":{
            "description":"Pluggable database name",
            "type":"string"
        },
        "pdbAdminUserName":{
            "description":"Pluggable database admin user name",
            "type":"string"
        },
        "enableTDE":{
            "description":"Flag to enable Transparent Data Encryption which uses software keystore",
            "type":"boolean"
        },
        "tdePassword":{
            "description":"Password for Password Protected KeyStore",
            "type":"string"
        },
        "dbType":{
            "description":"Database Type: SI, RAC, RACOne (default:SI)",
            "type":"string",
            "enum":[
                "RAC",
                "RACOne",
                "SI"
            ]
        },
        "dbRole":{
            "description":"Database role (PRIMARY/STANDBY).",
            "type":"string"
        },
        "dbTargetNodeNumber":{
            "description":"Target node number",
            "type":"string"
        },
        "dbClass":{
            "description":"Database Class EE: OLTP/DSS/IMDB, SE: OLTP (default:OLTP)",
            "type":"string",
            "enum":[
                "OLTP",
                "DSS",
                "IMDB"
            ]
        },
        "dbShape":{
            "description":"Database Shape{odb1s,odb1,odb2,etc.} (default:odb1)",
            "type":"string",
            "enum":[
                "odb1s",
                "odb1",
                "odb2",
                "odb4",
                "odb6",
                "odb8",
                "odb10",
                "odb12",
                "odb16",
                "odb20",
                "odb24",
                "odb28",
                "odb32",
                "odb36"
            ]
        },
        "dbStorage":{
            "description":"Database Storage {ACFS|ASM} (non case-sensitive) (default:ASM) 11.2.0.4 databases can be created only on ACFS storage",
            "type":"string",
            "enum":[
                "ASM",
                "ACFS"
            ]
        },
        "dbRedundancy":{
            "description":"Database redundancy",
            "type":"string"
        },
        "dbCharacterSet":{
            "description":"Character Set (default:AL32UTF8)",
            "$ref":"#/definitions/DbCharacterSet"
        },
        "dbConsoleEnable":{
            "description":"Flag to enable database console",
            "type":"boolean"
        },
        "backupConfigId":{
            "description":"Backup Config resource ID",
            "type":"string"
        },
        "backupDestination":{
            "description":"Backup Destination {Disk|ObjectStore|NFS|None}(case-insensitive)",
            "type":"string",
            "enum":[
                "NONE",
                "Disk",
                "ObjectStore",
                "Both"
            ]
        },
        "cloudStorageContainer":{
            "type":"string",
            "description":"if the object store backup is selected, then which container should the database backup go to."
        },
        "state":{
            "description":"Database resource state",
            "$ref":"#/definitions/ResourceState"
        },
        "createTime":{
            "description":"Database creation timestamp",
            "type":"string",
            "format":"date-time"
        },
        "updatedTime":{
            "description":"Database last updated timestamp",
            "type":"string",
            "format":"date-time"
        },
        "rmanBkupPassword":{
            "description":"RMAN backup password",
            "type":"string"
        },
        "dbEdition":{
            "description":"Database Edition",
            "type":"string"
        },
        "dbDomainName":{
            "description":"Database domain name",
            "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"
        }
    }
}

Nested Schema : associatedNetworks

Type: array

Show Source

• Array of: string

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

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

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "nodeNumber":{
            "type":"string"
        },
        "nodeName":{
            "type":"string"
        },
        "hostName":{
            "type":"string"
        },
        "vmSnapshotPath":{
            "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(optional): string
• currState(optional): string
• targetState(optional): 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(optional): string
• gateway(optional): string
• ipAddress(optional): string
• macAddress(optional): string
• name(optional): string
• netmask(optional): string
• types(optional): array types
• vnetworkName(optional): 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"
        },
        "types":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : types

Type: array

Show Source

• Array of: string

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

Nested Schema : DbSystemDisk

Type: object

Show Source

• devicePath(optional): string
• name(optional): string
• targetDevice(optional): string

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

Nested Schema : DbSystemVNetwork

Type: object

Show Source

• bridgeName(optional): string
• gateway(optional): string
• ipAddress(optional): string
• name(optional): string
• netmask(optional): string
• targetDevice(optional): string
• type(optional): string
• virtualFunction(optional): string
• vlanName(optional): 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: string
• message: string

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

Back to Top