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: string
DBVMs where the entity comes from. Name list is delimited by comma, like 's1,s2'.
-
includeDBVMEntity: boolean
include DBVM entitiesDefault Value:
false
-
includeLocalEntity: 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
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
-
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
Nested Schema : ResourceState
Type:
Show Source
object
-
status(optional):
string
Allowed Values:
[ "CREATING", "CONFIGURED", "UPDATING", "DELETING", "FAILED", "RUNNING", "ENABLED", "DISABLED", "STALE" ]
Default Response
An unexpected error has occurred