Backup a DB2 MultiNode Database

This operation is used to backup a DB2 MultiNode Subclient of a DB2 MultiNode Backupset

application/json

Request Body

• taskInfo object required

  associations object[] required

  subclientId integer required

  ID of the subclient for which backup needs to be triggered

  displayName string

  clientId integer required

  ID of the DB2 MultiNode Pseudo client

  instanceName string

  appName string

  applicationId integer required

  Possible values: [103]

  Application ID of DB2 MultiNode is 103

  clientName string

  Name of the DB2 MultiNode Pseudo Client

  backupsetId integer required

  ID of the backupset (DB2 MultiNode Database)

  instanceId integer required

  ID of the DB2 MuliNode instance

  subclientName string

  Name of the subclient

  backupsetName string

  Name of the backupset (DB2 MultiNode DB Name)

  task object required

  taskType integer required

  1 for backup / restore

  subTasks object[] required

  subTask object required

  subTaskType integer required

  2 for backup

  operationType integer required

  2 for backup

  options object required

  backupOpts object required

  backupLevel string required

  FULL / INCREMENTAL / DIFFERENTIAL

  commonOpts object

  notifyUserOnJobCompletion boolean

  True if you wish to notify via mail post job completion

  adminOpts object

  clientInstallOption object

  installerOption object

  User object

  userId integer

  userName string

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• taskId integer
• jobIds string[]

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

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
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Failed to create task.",
  "errorCode": 587204001
}

POST /createtask    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• API Request For Full DB2 MultiNode Backup
• API Request For Incremental DB2 MultiNode Backup
• API Request For DB2 MultiNode Differential Backup

---

{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "string",
        "applicationId": 103,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "string",
        "applicationId": 103,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "string",
        "applicationId": 103,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "string",
        "applicationId": 103,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "string",
        "applicationId": 103,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "string",
        "applicationId": 103,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "string",
        "applicationId": 103,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "string",
        "applicationId": 103,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'