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
- application/json
Request Body required
Request Body
instanceProperties object
excludeFromSLA booleanDefault value:
false
instance object
clientName string requiredCockroachDB instance client name
instanceName string requiredCockroachDB instance name
appName string requiredDefault value:
Big Data Apps
distributedClusterInstance object
clusterType integerDefault value:
8
opType integerDefault value:
2
instance object
instanceName stringCockroachDB instance name
dataAccessNodes object
dataAccessNodes object[]
clientName stringclusterConfig object
cockroachdbConfig object
dbCredentials object
credentialId integercockroachDB user credentials ID
dbHost stringport integersslCert stringsslKey stringsslRootCert stringstaging object
cloudURL stringinstanceType integerrecordType stringserviceHost stringstagingCredentials object
credentialId integercredentialName stringstagingPath stringstagingType integeruser object
password stringuserName string
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object[]
warningCode integererrorCode integerwarningMessage stringentity object
subclientId integerclientId integerinstanceName stringinstanceId integer_type_ integer
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": [
{
"warningCode": 0,
"errorCode": 0,
"warningMessage": "string",
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "string",
"instanceId": 0,
"_type_": 0
}
}
]
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "exitval",
"value": "0"
}
]
},
"response": [
{
"warningCode": 0,
"errorCode": 0,
"warningMessage": "",
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "",
"instanceId": 0,
"_type_": 0
}
}
]
}
Bad Request
- application/json
- application/xml
- Schema
- Example
Schema
- string
Request body is empty or format is invalid
- Schema
- Example (from schema)
Schema
- object
<root/>
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Loading...