Modify subclient
Select
This operation is used to modify subclient properties
Path Parameters
- subclientId integer required
Subclient Id of the subclient whose properties need to be read
- application/json
Request Body
subClientProperties object
commonProperties object
enableBackup booleansnapCopyInfo object
Use this object to enable and set snashop options
isSnapBackupEnabled booleanSet to true to enable Snap backups
snapToTapeSelectedEngine object
snapShotEngineId integerSelect snapshot engine Id.
snapShotEngineName stringSelect Snapshot engine name.
snapToTapeProxyToUse object
Select proxy for snap operations
clientId integerProxy client Id for snap operations.
clientName stringProxy client name for snap operations
snapToTapeProxyToUseSource booleanEnable this if you want to use source for snap operations in case proxy is unavailable.
useSeparateProxyForSnapToTape booleanSet this to true this if you want to use a proxy for backup copy.
separateProxyForSnapToTape object
This object is used to set proxy options for backup copy
clientId integerClient id of proxy to be used for backup copy
clientName stringClient name of proxy to be used for backup copy
backupCopyInterfacePossible values: [
RMAN
,FILE_SYSTEM
,VOLUME_COPY
]Select backup copy interface
prepostProcess object
Use this object to set pre-post backup operations.
preBackupCommand stringPath to the script to be run before backup
postBackupCommand stringPath to the script to be run post backup
runPostScan stringDefault value:
NO
runPostBackup stringDefault value:
NO
runAsPossible values: [
USE_IMPERSONATION
,USE_LOCAL_SYS_ADMIN
]Set to use impersonation if pre-post commands are to be run using a specific user
prepostUserName object
Prepost commands user credentials
userName stringPre-post command user
password stringBase64 encoded Pre-post command user password
oracleSubclientProp object
Set oracle subclient options
selectiveOnlineFull booleanSet to true to enable selective online full backups
data booleanSet to true if data is to be backed up
backupModePossible values: [
ONLINE_DB
,ONLINE_SUBSET_DB
,OFFLINE_DB
]Select backupmode for the subclient.
lightsOutScript booleanSet to true if the backupmode is OFFLINE_DB
enableTableBrowse booleanEnable this option to collect table metadata during backups
backupArchiveLog booleanSet this to true to backup Oracle archive logs
archiveDelete booleanSet this to true to delete backed up archivelogs
archiveDeleteAll booleanDefault value:
false
dataFilesPerBFS integerDefault value:
8
Oracle Filesperset paramter for datafiles
maxBackupSetSizeInKB integerOracle Maxset size parameter
archiveFilesPerBFS integerDefault value:
32
Oracle filesperset parameter for archivelogs
maxOpenFiles integerNumber of files that can be read by a stream simultaneuously
dataThresholdStreams integerNumber of data streams
sectionSizeInKB integerOracle section size parameter to create multi-section backup
useRmanForLogBackup booleanUse RMAN interface for log backups for snap backups
snapImageCopy booleanSet this to true to enable RMAN image copy
imageCopyDir stringEnter directory to save image copy
content string[]Select content if backupmode is set to ONLINE_SUBSET_DB
planEntity object
planName stringSelect plan associated to subclient
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object[]
warningCode integererrorCode integerwarningMessage string
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": [
{
"warningCode": 0,
"errorCode": 0,
"warningMessage": "string"
}
]
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "exitval",
"value": "0"
}
]
},
"response": [
{
"warningCode": 0,
"errorCode": 0,
"warningMessage": ""
}
]
}
Bad Request
- application/json
- application/xml
- Schema
- Example
Schema
- string
Request body is empty or format is invalid
- Schema
- Example (from schema)
Schema
- object
<root/>
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}