Add Subclient to a DB2 MultiNode Backupset
This operation is used to add a new subclient to a DB2 MultiNode Instance 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 integer requiredID of the DB2 MultiNode Pseudo Client
appName stringbackupsetName stringapplicationId integer requiredPossible values: [
103
]Application ID of DB2 MultiNode is 103
entityInfo object
companyId integercompanyName stringmultiCommcellId integersubclientId integersubclientName string requiredName of the subclient to be created
commonProperties objectplanEntity object required
planId integer requiredPass the ID of plan that needs to get associated to the subclient
contentOperationType integer required2 to add a subclient
db2SubclientProp object required
pass the properties of subclient in this object
db2BackupData boolean requiredTrue if data backup is enabled for the subclient
db2BackupMode integer required0 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 required0 if you dont want to include logs in backup image , 1 to include logs in backup image
db2UseDedupeDevice booleannumberOfBackupStreams integer requiredTotal numbers of streams that should be used
db2DpfStreams string requiredStreams for each Node
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 required
pass the tablespace inside this object
db2TableSpace string requiredTable space name
- 200
- 400
- 401
- 409
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object
warningCode integererrorCode integerwarningMessage stringentity object
subclientId integer_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": 15802,
"_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
}
Conflict
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "A subclient by this name already exists as part of this backup set.",
"errorCode": 3
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}