Skip to main content

Backup a DB2 Database​

Select

SaaS
Customer Managed

This operation is used to backup a DB2 Subclient of a DB2 backupset

Request Body
  • taskInfo object
  • associations object[]
  • subclientId integer required

    ID of the subclient for which backup needs to be triggered

  • displayName string

    Display name of the client

  • clientId integer required

    ID of the client

  • instanceName string

    Name of the DB2 instance

  • appName string

    Possible values: [DB2 on Unix, DB2]

    "DB2 on Unix" for a unix client , "DB2" for a windows client

  • applicationId integer required

    Possible values: [62, 37]

    application ID for DB2 Unix is 62 and application ID for DB2 windows is 37

  • clientName string

    Name of the client

  • backupsetId integer required

    ID of the backupset (DB2 Database)

  • instanceId integer required

    ID of the instance (DB2 Instance)

  • subclientName string

    Name of the subclient

  • backupsetName string

    Name of the backupset (DB2 DB name)

  • task object required
  • taskType integer required

    1 for backup / restore

  • subTasks object[]
  • subTask object required
  • subTaskType integer required

    2 for backup

  • operationType integer required

    2 for backup

  • options object
  • backupOpts object
  • backupLevel string required

    Possible values: [FULL, INCREMENTAL, DIFFERENTIAL]

    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

OK

Schema
  • taskId integer
  • jobIds string[]
POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "taskInfo": {

    "associations": [

      {

        "subclientId": 0,

        "displayName": "string",

        "clientId": 0,

        "instanceName": "string",

        "appName": "DB2 on Unix",

        "applicationId": 62,

        "clientName": "string",

        "backupsetId": 0,

        "instanceId": 0,

        "subclientName": "string",

        "backupsetName": "string"

      }

    ],

    "task": {

      "taskType": 0

    },

    "subTasks": [

      {

        "subTask": {

          "subTaskType": 0,

          "operationType": 0

        },

        "options": {

          "backupOpts": {

            "backupLevel": "FULL"

          },

          "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": "DB2 on Unix",
        "applicationId": 62,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "string",
        "backupsetName": "string"
      }
    ],
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          },
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 0,
                  "userName": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'