Create Couchbase Instance
This API is used to create a couchbase instance/pseudoclient
- application/json
Request Body
createPseudoClientRequest object required
Client object
clientInfo object required
clientType integer requiredDefault value:
29
plan object
Plan Info
planId integerSpecify planId or PlanName
planName stringPlan Name
type stringselected booleansubclientInfo object required
useLocalContent booleanFlag to use local backup content than plan
contentOperationType integercontent object[]
path stringBuckets in the couchbase cluster. Default is /
fsSubClientProp object
useGlobalFilters stringDefault value:
USE_CELL_LEVEL_POLICY
distributedClusterInstanceProperties object required
clusterType integerDefault value:
17
opType integerDefault value:
2
instance object
instanceName string requiredName of the couchbase instance
clientName string requiredapplicationId integer requiredDefault value:
64
clusterConfig object required
couchbaseConfig object required
CouchBase
port integerPort number used to connect couchbase cluster
user object
Credentials of the couchbase admin user
userName stringUserName
password stringBase 64 encoded password
staging object required
Stag
stagingType integer1 for S3, 0 for file system
stagingPath stringThe location of the backup archive directory
instanceType integerDefault value:
5
cloudURL strings3.[region].amazonaws.com
stagingCredentials object
S3 Account credentials
credentialId integercredentialName stringdataAccessNodes object
Couchbase nodes
dataAccessNodes object[]
List of access nodes
hostName stringclientId integerCouchbase node client id
clientName stringdisplayName stringselected booleanentity object
clientName stringInstance name
Responses
- 200
- 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
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Loading...