Skip to main content

Add DB2 Backupset to a instance​

Select

SaaS
Customer Managed

This operation is used to add a DB2 Backupset to a DB2 Instance

Request Body
  • backupSetInfo object required
  • backupSetEntity object required
  • clientName string
  • instanceName string
  • displayName string
  • instanceId integer required

    Id of the instance

  • instanceGUID string
  • clientId integer required

    ID of the client

  • appName string

    DB2

  • applicationId integer required

    Possible values: [37, 62]

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

  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • backupsetName string required

    name of the backupset

  • db2BackupSet object
  • dB2DefaultIndexSP object required
  • storagePolicyId integer required

    storage policy id that should be associated to log backups

  • dB2DefaultCommandSP object
  • storagePolicyId integer
  • commonBackupSet object
  • isDefaultBackupSet boolean
  • planEntity object required
  • planId integer required

    ID of the plan that should be associated to the backupset

  • planName string

    Plan name that should be associated to the backupset

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • errorCode integer
  • entity object

    general properties of backupset created

  • clientId integer
  • applicationId integer
  • backupsetId integer
  • _type_ integer
POST /backupset

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "backupSetInfo": {

    "backupSetEntity": {

      "clientName": "string",

      "instanceName": "string",

      "displayName": "string",

      "instanceId": 0,

      "instanceGUID": "string",

      "clientId": 0,

      "appName": "string",

      "applicationId": 37,

      "entityInfo": {

        "companyId": 0,

        "companyName": "string",

        "multiCommcellId": 0

      },

      "backupsetName": "string"

    },

    "db2BackupSet": {

      "dB2DefaultIndexSP": {

        "storagePolicyId": 0

      },

      "dB2DefaultCommandSP": {

        "storagePolicyId": 0

      }

    },

    "commonBackupSet": {

      "isDefaultBackupSet": true

    },

    "planEntity": {

      "planId": 0,

      "planName": "string"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Backupset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "backupSetInfo": {
    "backupSetEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "instanceId": 0,
      "instanceGUID": "string",
      "clientId": 0,
      "appName": "string",
      "applicationId": 37,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "backupsetName": "string"
    },
    "db2BackupSet": {
      "dB2DefaultIndexSP": {
        "storagePolicyId": 0
      },
      "dB2DefaultCommandSP": {
        "storagePolicyId": 0
      }
    },
    "commonBackupSet": {
      "isDefaultBackupSet": true
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    }
  }
}'