Create DB2 MultiNode Instance

Select

SaaS

Customer Managed

This operation is used to create a DB2 MultiNode Instance

application/json

Request Body

• instanceProperties object required

  instance object required

  instanceId integer

  instanceName string required

  Name of the DB2 MultiNode Instance to Create

  applicationId integer required

  Possible values: [103]

  clientId integer required

  ID of the Pseudo Client

  commCellId integer

  planEntity object

  Pass this object if you want to associate a plan to DB2 MultiNode Instance

  planId integer required

  Plan ID to associate to DB2 MultiNode Instance

  db2Instance object required

  homeDirectory string required

  DB2 MultiNode Primary Node Instance Home Directory

  pureScale boolean required

  dpfpartitionclients object[] required

  Pass all physicall and logical nodes of DB2 MultiNode environment

  nodenum integer required

  Node Number of the physical / logical Node

  nodeClient object required

  clientId integer required

  ID of the Client for which the Node belongs

  clientName string

  Name of the client for which the node belongs

  _type_ integer

  nodeNumber string required

  userAccount object required

  userName string required

  DB2 MultiNode Instance user name

  password string required

  DB2 MultiNode Instance Password in Base 64 Encoded format

  DB2StorageDevice object required

  dataBackupStoragePolicy object required

  storagePolicyId integer required

  Pass 1 to assign the plan given above or else pass the storage policy ID to get associated for GUI data backups

  logBackupStoragePolicy object required

  storagePolicyId integer required

  Pass 1 to associate same plan passed above or else pass storage policy ID to get associated for log backups

  commandLineStoragePolicy object required

  storagePolicyId integer required

  Pass 1 to associate same plan passed above or else pass the storage policy ID to get associated with command line backups

Responses

• 200
• 401
• 409
• 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

  subclientId integer

  clientId integer

  ID of the DB2 MultiNode Pseudo Client

  instanceName string

  Name of the DB2 MultiNode Instance created

  instanceId integer

  ID of the DB2 MultiNode Instance created

  _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": 1483,
      "instanceName": "dpfinst",
      "instanceId": 5419,
      "_type_": 0
    }
  }
}

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

  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": "An instance by this name already exists.",
  "errorCode": 3,
  "entity": {
    "subclientId": 0,
    "clientId": 1489,
    "instanceName": "dpfinst",
    "instanceId": -1,
    "_type_": 0
  }
}

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": "Failed to create new instance.",
  "errorCode": 1,
  "entity": {
    "subclientId": 0,
    "clientId": 1489111,
    "instanceName": "dpfinst",
    "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
• Example 1

---

{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 103,
      "clientId": 0,
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 0
          },
          "nodeNumber": "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": 103,
      "clientId": 0,
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 0
          },
          "nodeNumber": "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": 103,
      "clientId": 0,
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 0
          },
          "nodeNumber": "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": 103,
      "clientId": 0,
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 0
          },
          "nodeNumber": "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": 103,
      "clientId": 0,
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 0
          },
          "nodeNumber": "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": 103,
      "clientId": 0,
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 0
          },
          "nodeNumber": "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": 103,
      "clientId": 0,
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 0
          },
          "nodeNumber": "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": 103,
      "clientId": 0,
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 0
          },
          "nodeNumber": "string"
        }
      ],
      "userAccount": {
        "userName": "string",
        "password": "string"
      },
      "DB2StorageDevice": {
        "dataBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "logBackupStoragePolicy": {
          "storagePolicyId": 0
        },
        "commandLineStoragePolicy": {
          "storagePolicyId": 0
        }
      }
    }
  }
}'