Jump to

• Request
• Response

Modify database parameters

put

/databases/modifyDb

Modify the configuration of a database using DBModificationRequest parameters. Modifies backup configuration, database class, and database type

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

• backupConfigId(optional): string
  Backup Config resource ID
• backupConfigName(optional): string
  Backup Config resource name
• cpuPool(optional): string
  Defines the CPU Pool name
• currentTDEPassword(optional): string
  Current Password for Password Protected KeyStore. When specified without 'New TDE password' the TDE wallet will be re-keyed.
• databaseId(optional): string
  Database resource ID
• dbClass(optional): string
  Database Class EE: OLTP/DSS/IMDB, SE: OLTP (default:OLTP)
• dbId(optional): string
  Database resource ID
• dbName(optional): string
  Database resource Name
• dbRedundancy(optional): string
  Database redundancy
• dbShape(optional): string
  Database Shape{odb1s,odb1,odb2,etc.} (default:odb1)
• dbTargetNodeName(optional): string
  Target node name
• dbTargetNodeNumber(optional): string
  Target node number
• dbType(optional): string
  Database Type: SI, RAC, RACOne (default:SI)
• enableSEHA(optional): boolean
  Enable HA for SE for 19c and later SI database
• isAutoBackupDisabled(optional): boolean
  Flag to enable or disable auto backup
• isBackupDisabled(optional): boolean
  Flag to enable database backup
• 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. When specified along with 'Current TDE password', the password of the TDE wallet will be changed.
• noCpuPool(optional): boolean
  Removes the attached CPU Pool
• rmanBkupPassword(optional): string
  RMAN backup password

{
    "properties":{
        "dbId":{
            "description":"Database resource ID",
            "type":"string"
        },
        "dbName":{
            "description":"Database resource Name",
            "type":"string"
        },
        "backupConfigId":{
            "description":"Backup Config resource ID",
            "type":"string"
        },
        "backupConfigName":{
            "description":"Backup Config resource name",
            "type":"string"
        },
        "isAutoBackupDisabled":{
            "description":"Flag to enable or disable auto backup",
            "type":"boolean"
        },
        "rmanBkupPassword":{
            "description":"RMAN backup password",
            "type":"string"
        },
        "level0BackupDay":{
            "type":"string",
            "enum":[
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday",
                "saturday",
                "sunday"
            ]
        },
        "databaseId":{
            "description":"Database resource ID",
            "type":"string"
        },
        "isBackupDisabled":{
            "description":"Flag to enable database backup",
            "type":"boolean"
        },
        "currentTDEPassword":{
            "type":"string",
            "description":"Current Password for Password Protected KeyStore. When specified without 'New TDE password' the TDE wallet will be re-keyed."
        },
        "newTDEPassword":{
            "type":"string",
            "description":"New password for Password Protected Keystore. When specified along with 'Current TDE password', the password of the TDE wallet will be changed."
        },
        "dbClass":{
            "description":"Database Class EE: OLTP/DSS/IMDB, SE: OLTP (default:OLTP)",
            "type":"string"
        },
        "dbShape":{
            "description":"Database Shape{odb1s,odb1,odb2,etc.} (default:odb1)",
            "type":"string"
        },
        "networksToAdd":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "networksToRemove":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "dbTargetNodeNumber":{
            "description":"Target node number",
            "type":"string"
        },
        "enableSEHA":{
            "description":"Enable HA for SE for 19c and later SI database",
            "type":"boolean"
        },
        "dbType":{
            "description":"Database Type: SI, RAC, RACOne (default:SI)",
            "type":"string"
        },
        "dbTargetNodeName":{
            "description":"Target node name",
            "type":"string"
        },
        "cpuPool":{
            "description":"Defines the CPU Pool name",
            "type":"string"
        },
        "noCpuPool":{
            "description":"Removes the attached CPU Pool",
            "type":"boolean"
        },
        "dbRedundancy":{
            "description":"Database redundancy",
            "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)
  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