Update DB2 MultiNode Instance Properties

Select

SaaS

Customer Managed

This operation is used to update DB2 MultiNode Instance properties

Path Parameters

• InstanceID integer required

  ID of the DB2 MultiNode Instance

application/json

Request Body

• association object

  entity object[] required

  instanceId integer required

  ID of the DB2 MultiNode Instance

  instanceName string

  applicationId integer required

  Possible values: [103]

  103 for DB2 Multinode

  clientId integer required

  ID of the DB2 MultiNode pseudo client

  clientName string

  commCellId integer
• instanceProperties object required

  Pass the objects that you want to update inside this object

  instance object

  instanceId integer

  ID of the DB2 MultiNode Instance

  instanceName string

  Name of the DB2 MultiNode Instance

  applicationId integer

  Possible values: [103]

  clientId integer

  ID of the DB2 MultiNode pseudo client

  clientName string

  Name of the DB2 MultiNode pseudo client

  commCellId integer

  planEntity object

  Pass this object to update plan

  planId integer

  Plan id to get associated to DB2 MultiNode Instance

  db2Instance object

  pass this object to update DB2 MultiNode instance properties

  homeDirectory string

  DB2 MultiNode Instance home directory

  pureScale boolean

  True if using purescale else false

  dpfpartitionclients object[]

  pass this object to update physical or logical nodes of DB2 MultiNode Instance

  nodenum integer

  sequential number of the physical / logical node

  nodeClient object

  Client details of node

  clientId integer

  Client ID where physical / logical node is present

  clientName string

  Name of the cliet

  _type_ integer

  Possible values: [3]

  nodeNumber string

  sequential number of the node

  userAccount object

  Pass this object to update user details of DB2 MultiNode instance

  userName string

  User name of DB2 MultiNode Instance

  password string

  Password of the DB2 MultiNode Instance user

Responses

• 200
• 400
• 401
• 404
• 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

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

Not Found

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Unknown Instance information. Please provide valid instance id to complete the operation.",
  "errorCode": 587206385
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "User does not have [Use Plan] rights on plan(s)-[Invalid PlanId].",
  "errorCode": 1
}

POST /instance/:instanceid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

InstanceID — path required

Body

• Default
• API Request To Update DB2 MultiNode Instance Properties
• API Request To Update Plan

---

{
  "association": {
    "entity": [
      {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 103,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 103,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 3
          },
          "nodeNumber": "string"
        }
      ],
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 103,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 103,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 3
          },
          "nodeNumber": "string"
        }
      ],
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 103,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 103,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 3
          },
          "nodeNumber": "string"
        }
      ],
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 103,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 103,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 3
          },
          "nodeNumber": "string"
        }
      ],
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 103,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 103,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 3
          },
          "nodeNumber": "string"
        }
      ],
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 103,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 103,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 3
          },
          "nodeNumber": "string"
        }
      ],
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 103,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 103,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 3
          },
          "nodeNumber": "string"
        }
      ],
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 103,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 103,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "pureScale": true,
      "dpfpartitionclients": [
        {
          "nodenum": 0,
          "nodeClient": {
            "clientId": 0,
            "clientName": "string",
            "_type_": 3
          },
          "nodeNumber": "string"
        }
      ],
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  }
}'