Skip to main content

Update the CockroachDB instance properties​

Select

SaaS
Customer Managed

This operation is used to update the CockroachDB Instance properties

Path Parameters
  • instanceId integer required

    Id of the CockroachDB instance to be browsed

Request Body required

Request Body

  • instanceProperties object
  • excludeFromSLA boolean

    Default value: false

  • instance object
  • clientName string required

    CockroachDB instance client name

  • instanceName string required

    CockroachDB instance name

  • appName string required

    Default value: Big Data Apps

  • distributedClusterInstance object
  • clusterType integer

    Default value: 8

  • opType integer

    Default value: 2

  • instance object
  • instanceName string

    CockroachDB instance name

  • dataAccessNodes object
  • dataAccessNodes object[]
  • clientName string
  • clusterConfig object
  • cockroachdbConfig object
  • dbCredentials object
  • credentialId integer

    cockroachDB user credentials ID

  • dbHost string
  • port integer
  • sslCert string
  • sslKey string
  • sslRootCert string
  • staging object
  • cloudURL string
  • instanceType integer
  • recordType string
  • serviceHost string
  • stagingCredentials object
  • credentialId integer
  • credentialName string
  • stagingPath string
  • stagingType integer
  • user object
  • password string
  • userName string
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": {

      "clientName": "string",

      "instanceName": "string",

      "appName": "Big Data Apps"

    },

    "distributedClusterInstance": {

      "clusterType": 8,

      "opType": 2,

      "instance": {

        "instanceName": "string"

      },

      "dataAccessNodes": {

        "dataAccessNodes": [

          {

            "clientName": "string"

          }

        ]

      },

      "clusterConfig": {

        "cockroachdbConfig": {

          "dbCredentials": {

            "credentialId": 0

          },

          "dbHost": "string",

          "port": 0,

          "sslCert": "string",

          "sslKey": "string",

          "sslRootCert": "string",

          "staging": {

            "cloudURL": "string",

            "instanceType": 0,

            "recordType": "string",

            "serviceHost": "string",

            "stagingCredentials": {

              "credentialId": 0,

              "credentialName": "string"

            },

            "stagingPath": "string",

            "stagingType": 0

          },

          "user": {

            "password": "string",

            "userName": "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 '{
  "instanceProperties": {
    "excludeFromSLA": false,
    "instance": {
      "clientName": "string",
      "instanceName": "string",
      "appName": "Big Data Apps"
    },
    "distributedClusterInstance": {
      "clusterType": 8,
      "opType": 2,
      "instance": {
        "instanceName": "string"
      },
      "dataAccessNodes": {
        "dataAccessNodes": [
          {
            "clientName": "string"
          }
        ]
      },
      "clusterConfig": {
        "cockroachdbConfig": {
          "dbCredentials": {
            "credentialId": 0
          },
          "dbHost": "string",
          "port": 0,
          "sslCert": "string",
          "sslKey": "string",
          "sslRootCert": "string",
          "staging": {
            "cloudURL": "string",
            "instanceType": 0,
            "recordType": "string",
            "serviceHost": "string",
            "stagingCredentials": {
              "credentialId": 0,
              "credentialName": "string"
            },
            "stagingPath": "string",
            "stagingType": 0
          },
          "user": {
            "password": "string",
            "userName": "string"
          }
        }
      }
    }
  }
}'