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
Responses
- 200
- 400
- 401
- 409
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
response object
{
"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
}
POST /subclient
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 103,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"subclientId": 0,
"subclientName": "string"
},
"commonProperties": {},
"planEntity": {
"planId": 0
},
"contentOperationType": 0,
"db2SubclientProp": {
"db2BackupData": true,
"db2BackupMode": 0,
"db2BackupLogFiles": true,
"db2DeleteLogFilesAfter": true,
"skipLogsInBackupImage": 0,
"db2UseDedupeDevice": true,
"numberOfBackupStreams": 0,
"db2DpfStreams": "string",
"db2BackupType": 0
},
"content": [
{
"db2Content": {
"db2TableSpace": "string"
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 103,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"subclientId": 0,
"subclientName": "string"
},
"commonProperties": {},
"planEntity": {
"planId": 0
},
"contentOperationType": 0,
"db2SubclientProp": {
"db2BackupData": true,
"db2BackupMode": 0,
"db2BackupLogFiles": true,
"db2DeleteLogFilesAfter": true,
"skipLogsInBackupImage": 0,
"db2UseDedupeDevice": true,
"numberOfBackupStreams": 0,
"db2DpfStreams": "string",
"db2BackupType": 0
},
"content": [
{
"db2Content": {
"db2TableSpace": "string"
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 103,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"subclientId": 0,
"subclientName": "string"
},
"commonProperties": {},
"planEntity": {
"planId": 0
},
"contentOperationType": 0,
"db2SubclientProp": {
"db2BackupData": true,
"db2BackupMode": 0,
"db2BackupLogFiles": true,
"db2DeleteLogFilesAfter": true,
"skipLogsInBackupImage": 0,
"db2UseDedupeDevice": true,
"numberOfBackupStreams": 0,
"db2DpfStreams": "string",
"db2BackupType": 0
},
"content": [
{
"db2Content": {
"db2TableSpace": "string"
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 103,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"subclientId": 0,
"subclientName": "string"
},
"commonProperties": {},
"planEntity": {
"planId": 0
},
"contentOperationType": 0,
"db2SubclientProp": {
"db2BackupData": true,
"db2BackupMode": 0,
"db2BackupLogFiles": true,
"db2DeleteLogFilesAfter": true,
"skipLogsInBackupImage": 0,
"db2UseDedupeDevice": true,
"numberOfBackupStreams": 0,
"db2DpfStreams": "string",
"db2BackupType": 0
},
"content": [
{
"db2Content": {
"db2TableSpace": "string"
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 103,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"subclientId": 0,
"subclientName": "string"
},
"commonProperties": {},
"planEntity": {
"planId": 0
},
"contentOperationType": 0,
"db2SubclientProp": {
"db2BackupData": true,
"db2BackupMode": 0,
"db2BackupLogFiles": true,
"db2DeleteLogFilesAfter": true,
"skipLogsInBackupImage": 0,
"db2UseDedupeDevice": true,
"numberOfBackupStreams": 0,
"db2DpfStreams": "string",
"db2BackupType": 0
},
"content": [
{
"db2Content": {
"db2TableSpace": "string"
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 103,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"subclientId": 0,
"subclientName": "string"
},
"commonProperties": {},
"planEntity": {
"planId": 0
},
"contentOperationType": 0,
"db2SubclientProp": {
"db2BackupData": true,
"db2BackupMode": 0,
"db2BackupLogFiles": true,
"db2DeleteLogFilesAfter": true,
"skipLogsInBackupImage": 0,
"db2UseDedupeDevice": true,
"numberOfBackupStreams": 0,
"db2DpfStreams": "string",
"db2BackupType": 0
},
"content": [
{
"db2Content": {
"db2TableSpace": "string"
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": "string",
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 103,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
},
"subclientId": 0,
"subclientName": "string"
},
"commonProperties": {},
"planEntity": {
"planId": 0
},
"contentOperationType": 0,
"db2SubclientProp": {
"db2BackupData": true,
"db2BackupMode": 0,
"db2BackupLogFiles": true,
"db2DeleteLogFilesAfter": true,
"skipLogsInBackupImage": 0,
"db2UseDedupeDevice": true,
"numberOfBackupStreams": 0,
"db2DpfStreams": "string",
"db2BackupType": 0
},
"content": [
{
"db2Content": {
"db2TableSpace": "string"
}
}
]
}
}'