Jump to

• Request
• Response

Create KVM Database System

post

/dbsystem

Create a new KVM Database System in Oracle Database Appliance using DbSystemCreateParams. Make sure Oracle Database Appliance KVM DB System Image is downloaded and the repository is updated with the image first.

Request

Supported Media Types

• application/json

Body ()

Parameters to create a KVM Database System

Root Schema : DbSystemCreateParams

Type: object

Show Source

• database: object DbSystemCreateDatabaseParams
• grid(optional): object DbSystemCreateGridParams
• network(optional): object DbSystemCreateNetworkParams
• system: object DbSystemCreateSystemParams

{
    "type":"object",
    "required":[
        "system",
        "nodes",
        "database"
    ],
    "properties":{
        "system":{
            "$ref":"#/definitions/DbSystemCreateSystemParams"
        },
        "network":{
            "$ref":"#/definitions/DbSystemCreateNetworkParams"
        },
        "grid":{
            "$ref":"#/definitions/DbSystemCreateGridParams"
        },
        "database":{
            "$ref":"#/definitions/DbSystemCreateDatabaseParams"
        }
    }
}

Nested Schema : DbSystemCreateDatabaseParams

Type: object

Show Source

• adminPassword: string
• characterSet(optional): object DbCharacterSet
• dbClass: string
  Allowed Values: [ "OLTP", "DSS", "IMDB" ]
• domainName: string
• edition: string
  Allowed Values: [ "SE", "EE" ]
• enableDbConsole(optional): boolean
• enableFlashCache(optional): boolean
• enableFlashStorage(optional): boolean
• enableSEHA(optional): boolean
• enableTDE(optional): boolean
• enableUnifiedAuditing(optional): boolean
• isCdb(optional): boolean
• level0BackupDay(optional): string
  Allowed Values: [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]
• name: string
• pdbAdminUser(optional): string
• pdbName(optional): string
• redundancy(optional): string
• rmanBackupPassword(optional): string
• role: string
  Allowed Values: [ "PRIMARY", "STANDBY" ]
• shape: string
  Allowed Values: [ "odb1s", "odb1", "odb2", "odb4", "odb6", "odb8", "odb10", "odb12", "odb16", "odb20", "odb24", "odb28", "odb32", "odb36" ]
• targetNodeNumber(optional): integer
• tdePassword(optional): string
• type: string
  Allowed Values: [ "RAC", "RACOne", "SI" ]
• uniqueName: string
• version: string

{
    "type":"object",
    "required":[
        "name",
        "uniqueName",
        "domainName",
        "adminPassword",
        "version",
        "edition",
        "type",
        "dbClass",
        "shape",
        "role"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "uniqueName":{
            "type":"string"
        },
        "domainName":{
            "type":"string"
        },
        "adminPassword":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "edition":{
            "type":"string",
            "enum":[
                "SE",
                "EE"
            ]
        },
        "type":{
            "type":"string",
            "enum":[
                "RAC",
                "RACOne",
                "SI"
            ]
        },
        "dbClass":{
            "type":"string",
            "enum":[
                "OLTP",
                "DSS",
                "IMDB"
            ]
        },
        "shape":{
            "type":"string",
            "enum":[
                "odb1s",
                "odb1",
                "odb2",
                "odb4",
                "odb6",
                "odb8",
                "odb10",
                "odb12",
                "odb16",
                "odb20",
                "odb24",
                "odb28",
                "odb32",
                "odb36"
            ]
        },
        "role":{
            "type":"string",
            "enum":[
                "PRIMARY",
                "STANDBY"
            ]
        },
        "redundancy":{
            "type":"string"
        },
        "characterSet":{
            "$ref":"#/definitions/DbCharacterSet"
        },
        "enableDbConsole":{
            "type":"boolean"
        },
        "enableSEHA":{
            "type":"boolean"
        },
        "enableFlashStorage":{
            "type":"boolean"
        },
        "enableFlashCache":{
            "type":"boolean"
        },
        "rmanBackupPassword":{
            "type":"string"
        },
        "level0BackupDay":{
            "type":"string",
            "enum":[
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday",
                "saturday",
                "sunday"
            ]
        },
        "enableTDE":{
            "type":"boolean"
        },
        "tdePassword":{
            "type":"string"
        },
        "enableUnifiedAuditing":{
            "type":"boolean"
        },
        "isCdb":{
            "type":"boolean"
        },
        "pdbName":{
            "type":"string"
        },
        "pdbAdminUser":{
            "type":"string"
        },
        "targetNodeNumber":{
            "type":"integer"
        }
    }
}

Nested Schema : DbSystemCreateGridParams

Type: object

Show Source

• enableAFD(optional): boolean
• language(optional): string

{
    "type":"object",
    "properties":{
        "language":{
            "type":"string"
        },
        "enableAFD":{
            "type":"boolean"
        }
    }
}

Nested Schema : DbSystemCreateNetworkParams

Type: object

Show Source

• dnsServers: array dnsServers
• domainName: string
• nodes: array nodes
• ntpServers: array ntpServers
• publicVNetwork(optional): string
• scanIps(optional): array scanIps
• scanName(optional): string

{
    "type":"object",
    "required":[
        "domainName",
        "ntpServers",
        "dnsServers",
        "nodes"
    ],
    "properties":{
        "domainName":{
            "type":"string"
        },
        "ntpServers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "dnsServers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "scanName":{
            "type":"string"
        },
        "scanIps":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "nodes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemCreateNetworkNodeParams"
            }
        },
        "publicVNetwork":{
            "type":"string"
        }
    }
}

Nested Schema : DbSystemCreateSystemParams

Type: object

Show Source

• cpuPoolName(optional): string
• customRoleSeparation(optional): object DbSystemCreateRoleSeparationParams
• diskGroup(optional): string
• enableRoleSeparation(optional): boolean
• name: string
• provisionType(optional): string
• shape(optional): string
• systemPassword: string
• timeZone: string

{
    "type":"object",
    "required":[
        "name",
        "systemPassword",
        "timeZone"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "shape":{
            "type":"string"
        },
        "cpuPoolName":{
            "type":"string"
        },
        "diskGroup":{
            "type":"string"
        },
        "systemPassword":{
            "type":"string"
        },
        "provisionType":{
            "type":"string"
        },
        "timeZone":{
            "type":"string"
        },
        "enableRoleSeparation":{
            "type":"boolean"
        },
        "customRoleSeparation":{
            "$ref":"#/definitions/DbSystemCreateRoleSeparationParams"
        }
    }
}

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

Type: array

Show Source

• Array of: string

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

Nested Schema : nodes

Type: array

Show Source

• Array of: object DbSystemCreateNetworkNodeParams

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

Nested Schema : ntpServers

Type: array

Show Source

• Array of: string

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

Nested Schema : scanIps

Type: array

Show Source

• Array of: string

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

Nested Schema : DbSystemCreateNetworkNodeParams

Type: object

Show Source

• gateway: string
• ipAddress: string
• name: string
• netmask: string
• number: integer
• vipAddress(optional): string
• vipName(optional): string

{
    "type":"object",
    "required":[
        "number",
        "name",
        "ipAddress",
        "netmask",
        "gateway"
    ],
    "properties":{
        "number":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "ipAddress":{
            "type":"string"
        },
        "netmask":{
            "type":"string"
        },
        "gateway":{
            "type":"string"
        },
        "vipName":{
            "type":"string"
        },
        "vipAddress":{
            "type":"string"
        }
    }
}

Nested Schema : DbSystemCreateRoleSeparationParams

Type: object

Show Source

• groups: array groups
• users: array users

{
    "type":"object",
    "required":[
        "groups",
        "users"
    ],
    "properties":{
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemCreateGroupParams"
            }
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemCreateUserParams"
            }
        }
    }
}

Nested Schema : groups

Type: array

Show Source

• Array of: object DbSystemCreateGroupParams

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

Nested Schema : users

Type: array

Show Source

• Array of: object DbSystemCreateUserParams

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

Nested Schema : DbSystemCreateGroupParams

Type: object

Show Source

• id: integer
• name: string
• role: string

{
    "type":"object",
    "required":[
        "id",
        "name",
        "role"
    ],
    "properties":{
        "id":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "role":{
            "type":"string"
        }
    }
}

Nested Schema : DbSystemCreateUserParams

Type: object

Show Source

• id: integer
• name: string
• role: string

{
    "type":"object",
    "required":[
        "id",
        "name",
        "role"
    ],
    "properties":{
        "id":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "role":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : KvmJob

Type: object

Show Source

• jobId(optional): string
• jobReport(optional): object ServiceJobReport
  Job Request Status
• syncJob(optional): boolean

{
    "type":"object",
    "properties":{
        "syncJob":{
            "type":"boolean"
        },
        "jobId":{
            "type":"string"
        },
        "jobReport":{
            "$ref":"#/definitions/ServiceJobReport"
        }
    }
}

Nested Schema : ServiceJobReport

Type: object

Job Request Status

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 Request Status",
    "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
• resourceNewType(optional): string
• 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"
            ]
        },
        "resourceNewType":{
            "type":"string"
        },
        "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