Add DB2 Backupset to a instance

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

application/json

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

• 200
• 400
• 401
• 409
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

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

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "clientId": 0,
        "applicationId": 0,
        "backupsetId": 0,
        "_type_": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "clientId": 1272,
        "applicationId": 62,
        "backupsetId": 8706,
        "_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
• entity object

  clientId integer

  applicationId integer

  backupsetId integer

  _type_ integer

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "clientId": 0,
    "applicationId": 0,
    "backupsetId": 0,
    "_type_": 0
  }
}

{
  "errorMessage": "A backup set by this name already exists.",
  "errorCode": 3,
  "entity": {
    "clientId": 1272,
    "applicationId": 62,
    "backupsetId": 8726,
    "_type_": 0
  }
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer
• entity object

  clientId integer

  applicationId integer

  backupsetId integer

  _type_ integer

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "clientId": 0,
    "applicationId": 0,
    "backupsetId": 0,
    "_type_": 0
  }
}

{
  "errorMessage": "Please provide DB2 Log Backup Storage Policy.",
  "errorCode": 1,
  "entity": {
    "clientId": 1272,
    "applicationId": 62,
    "backupsetId": 8725,
    "_type_": 0
  }
}

Loading...