Create CockroachDB Instance

Select

SaaS

Customer Managed

This API is used to create a cockroachDB instance

application/json

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

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  errorCode integer

  entity object

  clientId integer

  clientName string

  instanceId integer

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "errorCode": 0,
    "entity": {
      "clientId": 0,
      "clientName": "string",
      "instanceId": 0,
      "_type_": 0
    }
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "errorCode": 0,
    "entity": {
      "clientId": 341,
      "clientName": "",
      "instanceId": 285,
      "_type_": 3
    }
  }
}

Bad Request

application/json

• Schema
• Example 1

---

Schema

• string

Request body is empty or format is invalid

Unauthorized

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

Loading...