Skip to main content

Create CockroachDB Instance​

Select

SaaS
Customer Managed

This API is used to create a cockroachDB instance

Request Body
  • createPseudoClientRequest object
  • clientInfo object
  • clientType integer
  • plan object
  • planName string
  • subclientInfo object
  • useLocalContent boolean
  • contentOperationType integer
  • content string
  • fsSubClientProp object
  • useGlobalFilters string
  • distributedClusterInstanceProperties object
  • clusterType integer
  • opType integer
  • instance object
  • instanceId integer
  • instanceName string
  • clientName string
  • applicationId integer

    Default value: 64

  • clusterConfig object
  • cockroachdbConfig object
  • port integer
  • sslRootCert string
  • sslCert string
  • sslKey string
  • user object
  • userName string
  • password string
  • dbHost string
  • dbCredentials object
  • credentialId integer
  • credentialName string
  • staging object
  • stagingType integer
  • stagingPath string
  • serviceHost string
  • instanceType integer
  • cloudURL string
  • stagingCredentials object
  • credentialId integer
  • credentialName string
  • dataAccessNodes object
  • dataAccessNodes object[]
  • hostName string
  • clientId integer
  • clientName string
  • displayName string
  • selected boolean
  • entity object
  • clientName string
Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • errorCode integer
  • entity object
  • clientId integer
  • clientName string
  • instanceId integer
  • _type_ integer
POST /client/cockroachdb

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "createPseudoClientRequest": {

    "clientInfo": {

      "clientType": 0,

      "plan": {

        "planName": "string"

      },

      "subclientInfo": {

        "useLocalContent": true,

        "contentOperationType": 0,

        "content": "string",

        "fsSubClientProp": {

          "useGlobalFilters": "string"

        }

      },

      "distributedClusterInstanceProperties": {

        "clusterType": 0,

        "opType": 0,

        "instance": {

          "instanceId": 0,

          "instanceName": "string",

          "clientName": "string",

          "applicationId": 64

        },

        "clusterConfig": {

          "cockroachdbConfig": {

            "port": 0,

            "sslRootCert": "string",

            "sslCert": "string",

            "sslKey": "string",

            "user": {

              "userName": "string",

              "password": "string"

            },

            "dbHost": "string",

            "dbCredentials": {

              "credentialId": 0,

              "credentialName": "string"

            },

            "staging": {

              "stagingType": 0,

              "stagingPath": "string",

              "serviceHost": "string",

              "instanceType": 0,

              "cloudURL": "string",

              "stagingCredentials": {

                "credentialId": 0,

                "credentialName": "string"

              }

            }

          }

        },

        "dataAccessNodes": {

          "dataAccessNodes": [

            {

              "hostName": "string",

              "clientId": 0,

              "clientName": "string",

              "displayName": "string",

              "selected": true

            }

          ]

        }

      }

    },

    "entity": {

      "clientName": "string"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Client/CockroachDB' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planName": "string"
      },
      "subclientInfo": {
        "useLocalContent": true,
        "contentOperationType": 0,
        "content": "string",
        "fsSubClientProp": {
          "useGlobalFilters": "string"
        }
      },
      "distributedClusterInstanceProperties": {
        "clusterType": 0,
        "opType": 0,
        "instance": {
          "instanceId": 0,
          "instanceName": "string",
          "clientName": "string",
          "applicationId": 64
        },
        "clusterConfig": {
          "cockroachdbConfig": {
            "port": 0,
            "sslRootCert": "string",
            "sslCert": "string",
            "sslKey": "string",
            "user": {
              "userName": "string",
              "password": "string"
            },
            "dbHost": "string",
            "dbCredentials": {
              "credentialId": 0,
              "credentialName": "string"
            },
            "staging": {
              "stagingType": 0,
              "stagingPath": "string",
              "serviceHost": "string",
              "instanceType": 0,
              "cloudURL": "string",
              "stagingCredentials": {
                "credentialId": 0,
                "credentialName": "string"
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            }
          ]
        }
      }
    },
    "entity": {
      "clientName": "string"
    }
  }
}'