Create DB2 Instance
Select
This operation is used to create a DB2 instance for a DB2 client
- application/json
Request Body
instanceProperties object required
instance object required
instanceId integerinstanceName string requiredName of the instance to be created
applicationId integer requiredPossible values: [
62
,37
]application ID for DB2 Unix is 62 and application ID for DB2 windows is 37
clientId integer requiredId of the client
clientName stringcommCellId integerplanEntity object
pass this object to associate a plan to the created instance
planId integerplan id of the plan to associate to the instance
db2Instance object required
homeDirectory string requireddb2 instance home directory path
userAccount object required
pass the credentials to connect to the db2 instance
userName string requireduser name of the instance
password string requiredBase64 encoded password
DB2StorageDevice object required
dataBackupStoragePolicy object required
storage policy for data backups
storagePolicyId integer requiredpass 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 requiredpass 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 requiredpass 1 if the same plan passed above needs to associated or pass the storage policy id that needs to be associated
- 200
- 400
- 401
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object
warningCode integererrorCode integerwarningMessage stringentity object
General properties of instance created
subclientId integerclientId integerinstanceName stringinstanceId 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 integerclientId integerinstanceName stringinstanceId 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
}
}