Get database by ID
get
/databases/{databaseId}
Describe database details by ID
Request
Supported Media Types
- application/json
Path Parameters
-
databaseId: string
database ID
Query Parameters
-
dbvms(optional): string
DBVMs where the entity comes from. Name list is delimited by comma, like 's1,s2'.
-
includeDBVMEntity(optional): boolean
include DBVM entitiesDefault Value:
false
-
includeLocalEntity(optional): boolean
include local entitiesDefault Value:
true
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : DB
Type:
Show Source
object
-
associatedNetworks(optional):
array associatedNetworks
-
backupConfigId(optional):
string
-
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)
-
databaseUniqueName(optional):
string
-
dbCharacterSet(optional):
object DbCharacterSet
-
dbClass(optional):
string
Allowed Values:
[ "OLTP", "DSS", "IMDB" ]
-
dbConsoleEnable(optional):
boolean
-
dbDomainName(optional):
string
-
dbEdition(optional):
string
Database Edition.
-
dbHomeId(optional):
string
The database home resource identifier for associating this database.
-
dbId(optional):
string
The database id
-
dbName(optional):
string
-
dbRedundancy(optional):
string
-
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", "odb42", "odb48", "odb56", "odb64" ]
-
dbStorage(optional):
string
Allowed Values:
[ "ASM", "ACFS", "PMEM" ]
-
dbTargetNodeName(optional):
string
-
dbTargetNodeNumber(optional):
string
-
dbType(optional):
string
Allowed Values:
[ "RAC", "RACOne", "SI" ]
-
dbVersion(optional):
string
-
enableEEHA(optional):
boolean
Enable HA for EE SI database
-
enableSEHA(optional):
boolean
-
enableTDE(optional):
boolean
Flag to create TDE enabled database
-
entitySource(optional):
string
Where the database is created. Null for local system.
-
id(optional):
string
-
instanceOnly(optional):
boolean
do not create the database files. Used in case of standby case to create standby instance.
-
isAutoBackupDisabled(optional):
boolean
-
isBcfgInSync(optional):
boolean
-
isCdb(optional):
boolean
-
level0BackupDay(optional):
string
Allowed Values:
[ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]
-
name(optional):
string
display name for the resource
-
pdbAdminUserName(optional):
string
-
pdBName(optional):
string
-
pdbs(optional):
array pdbs
List of PDB objects that are present in the CDB
-
quota(optional):
string
disk space quota for a database.
-
registerOnly(optional):
boolean
Use to migrate existing database
-
remark(optional):
string
Remark for database status
-
rmanBkupPassword(optional):
string
-
state(optional):
object ResourceState
-
tdePassword(optional):
string
Password for Password Protected KeyStore
-
tdeWalletManagement(optional):
string
Specify wallet management method for TDE enabled database. Allowed values are ODA and EXTERNAL.
-
updatedTime(optional):
string(date-time)
Nested Schema : ResourceState
Type:
Show Source
object
-
status(optional):
string
Allowed Values:
[ "CREATING", "CONFIGURED", "UPDATING", "DELETING", "FAILED", "RUNNING", "ENABLED", "DISABLED", "STALE" ]
Nested Schema : Pdb
Type:
Show Source
object
-
id(optional):
string
PDB Id
-
pdbName(optional):
string
Name of the PDB
-
sourcePdbArchivePath(optional):
string
The absolute file name of the PDB archive file if ARCHIVE is used in sourceType
-
sourcePdbName(optional):
string
The source PDB name if PDB is used in pdbSource
-
sourceType(optional):
string
Allowed Values:
[ "SEED", "PDB", "ARCHIVE" ]
The source type to create the PDB -
state(optional):
object ResourceState
Default Response
An unexpected error has occurred