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 required

    Default value: 29

  • plan object
  • planName string
  • planId integer
  • subclientInfo object
  • useLocalContent boolean
  • contentOperationType integer
  • content string
  • fsSubClientProp object
  • useGlobalFilters string
  • distributedClusterInstanceProperties object required
  • clusterType integer required

    Default value: 18

  • opType integer

    Default value: 2

  • instance object required
  • instanceId integer
  • instanceName string
  • clientName string
  • applicationId integer

    Default value: 64

  • clusterConfig object required
  • cockroachdbConfig object required
  • port integer required
  • user object
  • userName string
  • dbCredentials object required

    Either credentialId or credentialName must be provided

  • credentialId integer
  • credentialName string
  • sslCredentials object
  • credentialId integer
  • credentialName string
  • dbHost string required
  • staging object required
  • stagingType integer required

    Default value: 1

  • stagingPath string required
  • serviceHost string required
  • instanceType integer required

    Default value: 5

  • cloudURL string required
  • stagingCredentials object required

    Either credentialId or credentialName must be provided

  • credentialId integer
  • credentialName string
  • dataAccessNodes object required
  • dataAccessNodes object[]
  • clientId integer
  • selected boolean
  • entity object required
  • 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
Loading...