Create CockroachDB Instance
This API is used to create a cockroachDB instance
- application/json
Request Body
createPseudoClientRequest object
clientInfo object
clientType integerplan object
planName stringsubclientInfo object
useLocalContent booleancontentOperationType integercontent stringfsSubClientProp object
useGlobalFilters stringdistributedClusterInstanceProperties object
clusterType integeropType integerinstance object
instanceId integerinstanceName stringclientName stringapplicationId integerDefault value:
64
clusterConfig object
cockroachdbConfig object
port integersslRootCert stringsslCert stringsslKey stringuser object
userName stringpassword stringdbHost stringdbCredentials object
credentialId integercredentialName stringstaging object
stagingType integerstagingPath stringserviceHost stringinstanceType integercloudURL stringstagingCredentials object
credentialId integercredentialName stringdataAccessNodes object
dataAccessNodes object[]
hostName stringclientId integerclientName stringdisplayName stringselected booleanentity object
clientName string
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object
errorCode integerentity object
clientId integerclientName stringinstanceId 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...