Skip to main content

Update the cassandra instance properties​

This operation is used to update the cassandra instance properties

Path Parameters
  • instanceId integer required

    Id of the Cassandra instance to be updated

Request Body required

Request Body

  • instanceProperties object
  • excludeFromSLA boolean

    Default value: false

  • instance object
  • clientId integer

    Cassandra instance client Id

  • instanceId integer

    Cassandra instance Id

  • applicationId integer

    Default value: 64

  • distributedClusterInstance object
  • clusterType string
  • opType string
  • instance object
  • InstanceId integer
  • instanceName string

    Cassandra instance name

  • clusterConfig object
  • cassandrabConfig object
  • gateway object
  • node object
  • clientNode object
  • clientId integer
  • clientName string
  • jmxConnection object
  • port integer
  • userPassword object
  • userName string
  • password string
  • authConfig object
  • sslConfig object
  • useSSL boolean
  • keyStore string
  • keyStorePass string
  • trustStore string
  • trustStorePass string
  • gatewayCQLPort integer
  • gatewayCQLUser object
  • userName string
  • password string
  • nodes object[]
  • clientNode object
  • clientId integer
  • clientName string
  • clusterName string
  • enableCommitLog boolean
  • configFilePath string
  • isDeleted boolean
  • planEntity object
  • planName string
  • scIdxEnabled integer
  • indexSettings object
  • currentIndexServer object
  • currentIndexBackupSP object
  • autoDiscovered boolean
Responses

OK

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
POST /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
instanceId — path required
Body required
{

  "instanceProperties": {

    "excludeFromSLA": false,

    "instance": {

      "clientId": 0,

      "instanceId": 0,

      "applicationId": 64

    },

    "distributedClusterInstance": {

      "clusterType": "string",

      "opType": "string",

      "instance": {

        "InstanceId": 0,

        "instanceName": "string"

      },

      "clusterConfig": {

        "cassandrabConfig": {

          "gateway": {

            "node": {

              "clientNode": {

                "clientId": 0,

                "clientName": "string"

              },

              "jmxConnection": {

                "port": 0,

                "userPassword": {

                  "userName": "string",

                  "password": "string"

                }

              },

              "authConfig": {

                "sslConfig": {

                  "useSSL": true,

                  "keyStore": "string",

                  "keyStorePass": "string",

                  "trustStore": "string",

                  "trustStorePass": "string"

                }

              }

            },

            "gatewayCQLPort": 0,

            "gatewayCQLUser": {

              "userName": "string",

              "password": "string"

            }

          },

          "nodes": [

            {

              "clientNode": {

                "clientId": 0,

                "clientName": "string"

              }

            }

          ],

          "clusterName": "string",

          "enableCommitLog": true,

          "configFilePath": "string"

        }

      }

    },

    "isDeleted": true,

    "planEntity": {

      "planName": "string"

    },

    "scIdxEnabled": 0,

    "indexSettings": {

      "currentIndexServer": {},

      "currentIndexBackupSP": {}

    },

    "autoDiscovered": true

  }

}

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 '{
  "instanceProperties": {
    "excludeFromSLA": false,
    "instance": {
      "clientId": 0,
      "instanceId": 0,
      "applicationId": 64
    },
    "distributedClusterInstance": {
      "clusterType": "string",
      "opType": "string",
      "instance": {
        "InstanceId": 0,
        "instanceName": "string"
      },
      "clusterConfig": {
        "cassandrabConfig": {
          "gateway": {
            "node": {
              "clientNode": {
                "clientId": 0,
                "clientName": "string"
              },
              "jmxConnection": {
                "port": 0,
                "userPassword": {
                  "userName": "string",
                  "password": "string"
                }
              },
              "authConfig": {
                "sslConfig": {
                  "useSSL": true,
                  "keyStore": "string",
                  "keyStorePass": "string",
                  "trustStore": "string",
                  "trustStorePass": "string"
                }
              }
            },
            "gatewayCQLPort": 0,
            "gatewayCQLUser": {
              "userName": "string",
              "password": "string"
            }
          },
          "nodes": [
            {
              "clientNode": {
                "clientId": 0,
                "clientName": "string"
              }
            }
          ],
          "clusterName": "string",
          "enableCommitLog": true,
          "configFilePath": "string"
        }
      }
    },
    "isDeleted": true,
    "planEntity": {
      "planName": "string"
    },
    "scIdxEnabled": 0,
    "indexSettings": {
      "currentIndexServer": {},
      "currentIndexBackupSP": {}
    },
    "autoDiscovered": true
  }
}'