Create DB2 Instance

This operation is used to create a DB2 instance for a DB2 client

application/json

Request Body

• instanceProperties object required

  instance object required

  instanceId integer

  instanceName string required

  Name of the instance to be created

  applicationId integer required

  Possible values: [62, 37]

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

  clientId integer required

  Id of the client

  clientName string

  commCellId integer

  planEntity object

  pass this object to associate a plan to the created instance

  planId integer

  plan id of the plan to associate to the instance

  db2Instance object required

  homeDirectory string required

  db2 instance home directory path

  userAccount object required

  pass the credentials to connect to the db2 instance

  userName string required

  user name of the instance

  password string required

  Base64 encoded password

  DB2StorageDevice object required

  dataBackupStoragePolicy object required

  storage policy for data backups

  storagePolicyId integer required

  pass 1 if the same plan passed above needs to associated or pass the storage policy id that needs to be associated

  logBackupStoragePolicy object required

  storage policy for log backups

  storagePolicyId integer required

  pass 1 if the same plan passed above needs to associated or pass the storage policy id that needs to be associated

  commandLineStoragePolicy object required

  storage policy for command line jobs

  storagePolicyId integer required

  pass 1 if the same plan passed above needs to associated or pass the storage policy id that needs to be associated

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  warningCode integer

  errorCode integer

  warningMessage string

  entity object

  General properties of instance created

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "string",
    "entity": {
      "subclientId": 0,
      "clientId": 0,
      "instanceName": "string",
      "instanceId": 0,
      "_type_": 0
    }
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "",
    "entity": {
      "subclientId": 0,
      "clientId": 1272,
      "instanceName": "db2inst2",
      "instanceId": 5281,
      "_type_": 0
    }
  }
}

Bad Request

Unauthorized

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer
• entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "subclientId": 0,
    "clientId": 0,
    "instanceName": "string",
    "instanceId": 0,
    "_type_": 0
  }
}

{
  "errorMessage": "Please provide DB2 Storage device information.",
  "errorCode": 1,
  "entity": {
    "subclientId": 0,
    "clientId": 1272,
    "instanceName": "db2inst4",
    "instanceId": -1,
    "_type_": 0
  }
}

POST /instance    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• API Request to add a DB2 instance
• API request to add windows DB2 instance

---

{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 62,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      },
      "DB2StorageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "commandLineStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 62,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      },
      "DB2StorageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "commandLineStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 62,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      },
      "DB2StorageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "commandLineStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 62,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      },
      "DB2StorageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "commandLineStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 62,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      },
      "DB2StorageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "commandLineStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 62,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      },
      "DB2StorageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "commandLineStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 62,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      },
      "DB2StorageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "commandLineStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 62,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      },
      "DB2StorageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "commandLineStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    }
  }
}'