Jump to

• Request
• Response

Modifying database parameters

put

/databases/modifyDb

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 parameters

Root Schema : DBModificationRequest

Type: object

Show Source

• adminPassword(optional): string
  Password for the newly created CDB
• backupConfigId(optional): string
• backupConfigName(optional): string
• cdbName(optional): string
  Convert a singleton database to a Pluggable database of a newly specified Container database(CDB). If the specified CDB does not exist, then a new CDB will be created with the specified name.
• cpuPool(optional): string
  Defines the CPU Pool name
• currentTDEPassword(optional): string
  Current Password for Password Protected KeyStore
• databaseId(optional): string
  Database Id
• dbClass(optional): string
• dbId(optional): string
  Database resource ID
• dbName(optional): string
  Database resource Name
• dbRedundancy(optional): string
• dbShape(optional): string
• dbTargetNodeName(optional): string
• dbTargetNodeNumber(optional): string
• dbType(optional): string
• deleteExistingNonCDB(optional): boolean
  Delete previous non CDB after converting it into a CDB
• enableEEHA(optional): boolean
  Enable HA for EE SI database
• enableSEHA(optional): boolean
  Enable HA for SE for 19c and later SI database
• isAutoBackupDisabled(optional): boolean
• isBackupDisabled(optional): boolean
• level0BackupDay(optional): string
  Allowed Values: [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]
• networksToAdd(optional): array networksToAdd
• networksToRemove(optional): array networksToRemove
• newTDEPassword(optional): string
  New password for Password Protected Keystore
• noCpuPool(optional): boolean
  Removes the attached CPU Pool
• pdbFilePath(optional): string
  Absolute file path for ARCHIVE file (.tar file)
• pdbName(optional): string
  Pluggable database name.
• rmanBkupPassword(optional): string
• tdePassword(optional): string
  Password for Password Protected KeyStore
• tdeWalletMgmt(optional): boolean
  When specified TDE wallet management will be changed from EXTERNAL to ODA.
• unplugPDB(optional): boolean
  Unplug a PDB from a CDB

{
    "properties":{
        "dbId":{
            "description":"Database resource ID",
            "type":"string"
        },
        "dbName":{
            "description":"Database resource Name",
            "type":"string"
        },
        "backupConfigId":{
            "type":"string"
        },
        "backupConfigName":{
            "type":"string"
        },
        "isAutoBackupDisabled":{
            "type":"boolean"
        },
        "rmanBkupPassword":{
            "type":"string"
        },
        "level0BackupDay":{
            "type":"string",
            "enum":[
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday",
                "saturday",
                "sunday"
            ]
        },
        "databaseId":{
            "description":"Database Id",
            "type":"string"
        },
        "isBackupDisabled":{
            "type":"boolean"
        },
        "currentTDEPassword":{
            "type":"string",
            "description":"Current Password for Password Protected KeyStore"
        },
        "newTDEPassword":{
            "type":"string",
            "description":"New password for Password Protected Keystore"
        },
        "tdeWalletMgmt":{
            "type":"boolean",
            "description":"When specified TDE wallet management will be changed from EXTERNAL to ODA."
        },
        "dbClass":{
            "type":"string"
        },
        "dbShape":{
            "type":"string"
        },
        "networksToAdd":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "networksToRemove":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "dbTargetNodeNumber":{
            "type":"string"
        },
        "enableSEHA":{
            "description":"Enable HA for SE for 19c and later SI database",
            "type":"boolean"
        },
        "enableEEHA":{
            "description":"Enable HA for EE SI database",
            "type":"boolean"
        },
        "dbType":{
            "type":"string"
        },
        "dbTargetNodeName":{
            "type":"string"
        },
        "dbRedundancy":{
            "type":"string"
        },
        "cpuPool":{
            "description":"Defines the CPU Pool name",
            "type":"string"
        },
        "noCpuPool":{
            "description":"Removes the attached CPU Pool",
            "type":"boolean"
        },
        "cdbName":{
            "description":"Convert a singleton database to a Pluggable database of a newly specified Container database(CDB). If the specified CDB does not exist, then a new CDB will be created with the specified name.",
            "type":"string"
        },
        "adminPassword":{
            "description":"Password for the newly created CDB",
            "type":"string"
        },
        "deleteExistingNonCDB":{
            "description":"Delete previous non CDB after converting it into a CDB",
            "type":"boolean"
        },
        "unplugPDB":{
            "description":"Unplug a PDB from a CDB",
            "type":"boolean"
        },
        "pdbName":{
            "description":"Pluggable database name.",
            "type":"string"
        },
        "pdbFilePath":{
            "description":"Absolute file path for ARCHIVE file (.tar file)",
            "type":"string"
        },
        "tdePassword":{
            "description":"Password for Password Protected KeyStore",
            "type":"string"
        }
    }
}

Nested Schema : networksToAdd

Type: array

Show Source

• Array of: string

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

Nested Schema : networksToRemove

Type: array

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Database modification state.

Body ()

Root Schema : ServiceJobReport

Type: object

Job Request Status

Show Source

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

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

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

• duration(optional): string
• endTime(optional): string(date-time)
• jobId(optional): string
• nodeName(optional): string
• parentTaskId(optional): string
• reportLevel(optional): string
  Allowed Values: [ "Verbose", "Info", "Error" ]
• startTime(optional): string(date-time)
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "Skipped" ]
• tags(optional): array tags
• taskDescription(optional): string
• taskId(optional): string
• taskName(optional): string
• taskResult(optional): string
• updatedTime(optional): string(date-time)

{
    "properties":{
        "taskId":{
            "type":"string"
        },
        "taskName":{
            "type":"string"
        },
        "nodeName":{
            "type":"string"
        },
        "taskResult":{
            "type":"string"
        },
        "startTime":{
            "type":"string",
            "format":"date-time"
        },
        "endTime":{
            "type":"string",
            "format":"date-time"
        },
        "duration":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure",
                "Skipped"
            ]
        },
        "taskDescription":{
            "type":"string"
        },
        "parentTaskId":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reportLevel":{
            "type":"string",
            "enum":[
                "Verbose",
                "Info",
                "Error"
            ]
        },
        "updatedTime":{
            "type":"string",
            "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
• resourceId(optional): string
• resourceNewType(optional): string
• resourceType(optional): string
  Allowed Values: [ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Pdb", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]
• updatedTime(optional): string(date-time)

{
    "description":"resource information",
    "properties":{
        "resourceId":{
            "type":"string"
        },
        "resourceType":{
            "type":"string",
            "enum":[
                "Backup",
                "BackupConfig",
                "DB",
                "DbHome",
                "Grid",
                "Pdb",
                "Recovery",
                "Report",
                "Tde",
                "ObjectStoreSwift"
            ]
        },
        "resourceNewType":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "updatedTime":{
            "type":"string",
            "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