Add Subclient to a DB2 Backupset
This operation is used to add a new subclient to a DB2 Backupset
- application/json
Request Body
subClientProperties object required
subClientEntity object required
clientName stringinstanceName stringdisplayName stringbackupsetId integer requiredId of the backupset under which subclient needs to be added
_type_ stringinstanceId integer requiredID of the instance under which backupset is present
backupsetGUID stringclientId integerappName stringbackupsetName stringapplicationId integer requiredPossible values: [
62
,37
]application ID for DB2 Unix is 62 and application ID for DB2 windows is 37
entityInfo object
companyId integercompanyName stringmultiCommcellId integersubclientId integersubclientName string requiredName of the subclient to be created
commonProperties object requiredplanEntity object
planId integer requiredcontentOperationType integerdb2SubclientProp object required
pass the properties of subclient in this object
db2BackupData boolean requiredTrue if data backup is enabled for the subclient
db2BackupMode integer requiredPossible values: [
0
,1
]0 for online database and 1 for offline database
db2BackupLogFiles boolean requiredTrue if log backup is enabled for the subclient
db2DeleteLogFilesAfter boolean requiredTrue if log files should be deleted from archive path post log backup
skipLogsInBackupImage integer requiredPossible values: [
0
,1
]0 if you don't want to include logs in backup image , 1 to include logs in backup image
db2UseDedupeDevice booleanTrue if dedup device to be used else False
numberOfBackupStreams integer requiredNumber of backup streams that needs to be used during data backup
db2BackupType integer1 in case of using subset option
content object[]
pass this object if you want to create subclient with subset of tablespaces
db2Content object
pass the tablespace inside this object
db2TableSpace stringTable space name
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object
warningCode integererrorCode integerwarningMessage stringentity object
subclientId integerID of the subclient created
_type_ integer
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": {
"warningCode": 0,
"errorCode": 0,
"warningMessage": "string",
"entity": {
"subclientId": 0,
"_type_": 0
}
}
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "exitval",
"value": "0"
}
]
},
"response": {
"warningCode": 0,
"errorCode": 0,
"warningMessage": "",
"entity": {
"subclientId": 15369,
"_type_": 0
}
}
}
Bad Request
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access denied",
"errorCode": 5
}