Jump to

• Request
• Response

Create database

post

/databases

Create new database in Oracle Database Appliance using DBRequest parameters. Ensure that the repository is updated with Oracle RDBMS Clone files for the database version, before creating the database.

Request

Supported Media Types

• application/json

Header Parameters

• opc-idempotency-token: string
  Minimum Length: 1

  Maximum Length: 64

  A user-supplied token that uniquely identifies a request. A single request will be acted upon among many requests that share the same token. Idempotency tokens expire after 30 minutes.

Body ()

database creation parameters

Root Schema : DBRequest

Type: object

Show Source

• adminPassword(optional): string
  Admin password
• associatedNetworkNames(optional): array associatedNetworkNames
  names of associated networks
• associatedNetworks(optional): array associatedNetworks
  ids of associated networks
• backupConfigId(optional): string
  Backup Config resource ID
• backupConfigName(optional): string
  Backup Config resource name
• 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 Home Edition(EE/SE).
• dbHomeId(optional): string
  The database home resource identifier for associating this database to.
• dbName: string
  Database name
• dbOnFlashStorage(optional): boolean
  Option to select FLASH for storing database data files
• dbRedundancy(optional): string
  Database redundancy
• 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
• 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
• enableFlashCache(optional): boolean
  Option to enable FLASH CACHE
• enableTDE(optional): boolean
  Flag to enable Transparent Data Encryption which uses software keystore
• instanceOnly(optional): boolean
  Do not create the database files. Flag to create standby instance.
• isCdb(optional): boolean
  Flag to create container database
• level0BackupDay(optional): string
  Allowed Values: [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]
• pdbAdminuserName(optional): string
  Pluggable database admin user name
• pdBName(optional): string
  Pluggable database name
• registerOnly(optional): boolean
  Flag to migrate existing database
• rmanBkupPassword(optional): string
  RMAN backup password
• unifiedAuditing(optional): string
  Enable unified auditing for the database or not (TRUE/FALSE).

{
    "required":[
        "dbName"
    ],
    "properties":{
        "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 to.",
            "type":"string"
        },
        "instanceOnly":{
            "description":"Do not create the database files. Flag to create standby instance.",
            "type":"boolean"
        },
        "registerOnly":{
            "description":"Flag to migrate existing database",
            "type":"boolean"
        },
        "isCdb":{
            "description":"Flag to create container database",
            "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"
        },
        "adminPassword":{
            "description":"Admin password",
            "type":"string"
        },
        "dbType":{
            "description":"Database Type: SI, RAC, RACOne (default:SI)",
            "type":"string",
            "enum":[
                "RAC",
                "RACOne",
                "SI"
            ]
        },
        "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":"Database character set",
            "$ref":"#/definitions/DbCharacterSet"
        },
        "dbConsoleEnable":{
            "description":"Flag to enable database console",
            "type":"boolean"
        },
        "backupConfigId":{
            "description":"Backup Config resource ID",
            "type":"string"
        },
        "backupConfigName":{
            "description":"Backup Config resource name",
            "type":"string"
        },
        "dbOnFlashStorage":{
            "description":"Option to select FLASH for storing database data files",
            "type":"boolean"
        },
        "dbEdition":{
            "description":"Database Home Edition(EE/SE).",
            "type":"string"
        },
        "rmanBkupPassword":{
            "description":"RMAN backup password",
            "type":"string"
        },
        "dbDomainName":{
            "description":"Database domain name",
            "type":"string"
        },
        "enableFlashCache":{
            "description":"Option to enable FLASH CACHE",
            "type":"boolean"
        },
        "level0BackupDay":{
            "type":"string",
            "enum":[
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday",
                "saturday",
                "sunday"
            ]
        },
        "associatedNetworks":{
            "description":"ids of associated networks",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "associatedNetworkNames":{
            "description":"names of associated networks",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unifiedAuditing":{
            "description":"Enable unified auditing for the database or not (TRUE/FALSE).",
            "type":"string"
        }
    }
}

Nested Schema : associatedNetworkNames

Type: array

names of associated networks

Show Source

• Array of: string

{
    "description":"names of associated networks",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : associatedNetworks

Type: array

ids of associated networks

Show Source

• Array of: string

{
    "description":"ids of associated networks",
    "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ServiceJobReport

Type: object

Job report information

Show Source

• createTimestamp(optional): string(date-time)
  Job creation timestamp
• description(optional): string
  Job description
• jobId(optional): string
  Job ID
• message(optional): string
  Job message
• reports(optional): array reports
• resourceList(optional): array resourceList
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]

  Job status
• updatedTime(optional): string(date-time)
  Job modification timestamp

{
    "description":"Job report information",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Job ID"
        },
        "status":{
            "type":"string",
            "description":"Job status",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure"
            ]
        },
        "message":{
            "description":"Job message",
            "type":"string"
        },
        "reports":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskReport"
            }
        },
        "createTimestamp":{
            "type":"string",
            "description":"Job creation timestamp",
            "format":"date-time"
        },
        "resourceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/JobResourceInfo"
            }
        },
        "description":{
            "type":"string",
            "description":"Job description"
        },
        "updatedTime":{
            "type":"string",
            "description":"Job modification timestamp",
            "format":"date-time"
        }
    }
}

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

• endTime(optional): string(date-time)
  Task completion timestamp
• jobId(optional): string
  Task associated with a job ID
• parentTaskId(optional): string
  Task ID of parent task
• reportLevel(optional): string
  Allowed Values: [ "Verbose", "Info", "Error" ]

  Task report level
• startTime(optional): string(date-time)
  Task creation timestamp
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]

  Task status
• tags(optional): array tags
• taskDescription(optional): string
  Task description
• taskId(optional): string
  Task ID
• taskName(optional): string
  Task name
• taskResult(optional): string
  Task result
• updatedTime(optional): string(date-time)
  Task updation timestamp

{
    "properties":{
        "taskId":{
            "type":"string",
            "description":"Task ID"
        },
        "taskName":{
            "type":"string",
            "description":"Task name"
        },
        "taskResult":{
            "type":"string",
            "description":"Task result"
        },
        "startTime":{
            "type":"string",
            "description":"Task creation timestamp",
            "format":"date-time"
        },
        "endTime":{
            "type":"string",
            "description":"Task completion timestamp",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "description":"Task status",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure"
            ]
        },
        "taskDescription":{
            "type":"string",
            "description":"Task description"
        },
        "parentTaskId":{
            "type":"string",
            "description":"Task ID of parent task"
        },
        "jobId":{
            "type":"string",
            "description":"Task associated with a job ID"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reportLevel":{
            "type":"string",
            "description":"Task report level",
            "enum":[
                "Verbose",
                "Info",
                "Error"
            ]
        },
        "updatedTime":{
            "type":"string",
            "description":"Task updation timestamp",
            "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
  Job ID
• resourceId(optional): string
  Resource ID
• resourceType(optional): string
  Allowed Values: [ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]

  Resource type
• updatedTime(optional): string(date-time)
  Last updated timestamp

{
    "description":"Resource information",
    "properties":{
        "resourceId":{
            "type":"string",
            "description":"Resource ID"
        },
        "resourceType":{
            "type":"string",
            "description":"Resource type",
            "enum":[
                "Backup",
                "BackupConfig",
                "DB",
                "DbHome",
                "Grid",
                "Recovery",
                "Report",
                "Tde",
                "ObjectStoreSwift"
            ]
        },
        "jobId":{
            "type":"string",
            "description":"Job ID"
        },
        "updatedTime":{
            "type":"string",
            "description":"Last updated timestamp",
            "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