Update DB2 Instance Properties

Select

SaaS

Customer Managed

This operation is used to update DB2 instance properties

Path Parameters

• InstanceID integer required

  ID of the instance

application/json

Request Body

• association object

  entity object[]

  instanceId integer

  ID of the instance

  instanceName string

  Name of the instance

  applicationId integer

  Possible values: [62, 37]

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

  clientId integer

  ID of the client

  clientName string

  Name of the client

  commCellId integer
• instanceProperties object required

  pass the properties that needs to be updated in this object

  instance object

  instanceId integer

  instanceName string

  applicationId integer

  clientId integer

  clientName string

  commCellId integer

  planEntity object

  pass this object to update plan of the instance

  planId integer

  Id of the new plan

  db2Instance object

  pass this object to update db2 home directory or the user details

  homeDirectory string

  pass the new home directory for db2 instance

  userAccount object

  pass this object if the user details needs to be changed for the instance

  userName string

  username to connect to specified instance

  password string

  Base64 encoded password

• newName string

  New instance name

Responses

• 200
• 400
• 401
• 404
• 409

---

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
}

Conflict

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "An instance by this name already exists.",
  "errorCode": 3
}

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 Instance Properties
• API request to update DB2 instance properties of windows instance

---

{
  "association": {
    "entity": [
      {
        "instanceId": 0,
        "instanceName": "string",
        "applicationId": 62,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  },
  "newName": "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": 62,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  },
  "newName": "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": 62,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  },
  "newName": "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": 62,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  },
  "newName": "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": 62,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  },
  "newName": "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": 62,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  },
  "newName": "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": 62,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  },
  "newName": "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": 62,
        "clientId": 0,
        "clientName": "string",
        "commCellId": 0
      }
    ]
  },
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "db2Instance": {
      "homeDirectory": "string",
      "userAccount": {
        "userName": "string",
        "password": "string"
      }
    }
  },
  "newName": "string"
}'