REST APIs for Oracle Database Appliance Release 19.26

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.

Database parameters

Root Schema : DBModificationRequest

Type: object

Show Source

adminPassword: string

Password for the newly created CDB
backupConfigId: string
backupConfigName: string
cdbName: 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: string

Defines the CPU Pool name
currentTDEPassword: string

Current Password for Password Protected KeyStore
databaseId: string

Database Id
dbClass: string
dbId: string

Database resource ID
dbName: string

Database resource Name
dbRedundancy: string
dbShape: string
dbTargetNodeName: string
dbType: string
deleteExistingNonCDB: boolean

Deletes previous non CDB after converting it into a CDB
enableEEHA: boolean

Enable HA for EE SI database
enableSEHA: boolean

Enable HA for SE for 19c and later SI database
isAutoBackupDisabled: boolean
isBackupDisabled: boolean
isChangeTdePassword: boolean

Flag specified to change the TDE password of the database.
isReKey: boolean

When specified TDE Master Encryption key will be Re-Keyed. Default is False
level0BackupDay: string

Allowed Values: [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]
networksToAdd: array networksToAdd
networksToRemove: array networksToRemove
newTDEPassword: string

New password for Password Protected Keystore
noCpuPool: boolean

Removes the attached CPU Pool
pdbFilePath: string

Absolute file path for ARCHIVE file (.tar file)
pdbName: string

Pluggable database name.
rmanBkupPassword: string
tdePassword: string

Password for Password Protected KeyStore
tdeWalletMgmt: boolean

When specified TDE wallet management will be changed from EXTERNAL to ODA.
unplugPDB: 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."
        },
        "isReKey":{
            "type":"boolean",
            "description":"When specified TDE Master Encryption key will be Re-Keyed. Default is False"
        },
        "dbClass":{
            "type":"string"
        },
        "dbShape":{
            "type":"string"
        },
        "networksToAdd":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "networksToRemove":{
            "type":"array",
            "items":{
                "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":"Deletes 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"
        },
        "isChangeTdePassword":{
            "description":"Flag specified to change the TDE password of the database.",
            "type":"boolean"
        }
    }
}

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"
    }
}

Response

Supported Media Types

application/json

200 Response

Database modification state.

Root Schema : ServiceJobReport

Type: object

Job Request Status

Show Source

cpsMetadata: string
createTimestamp: string(date-time)
description: string
jobId: string
jobType: string
message: string
reports: array reports
resourceList: array resourceList
status: string

Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]
updatedTime: 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"
        },
        "cpsMetadata":{
            "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: string
endTime: string(date-time)
jobId: string
nodeName: string
parentTaskId: string
reportLevel: string

Allowed Values: [ "Verbose", "Info", "Error" ]
startTime: string(date-time)
status: string

Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "Skipped" ]
tags: array tags
taskDescription: string
taskId: string
taskName: string
taskResult: string
updatedTime: 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: string
resourceId: string
resourceNewType: string
resourceType: string

Allowed Values: [ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Pdb", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]
updatedTime: 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

Root Schema : Error

Type: object

Show Source

code(required): string
message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}