Skip to main content

Create Couchbase Instance​

Select

SaaS
Customer Managed

This API is used to create a couchbase instance/pseudoclient

Request Body
  • createPseudoClientRequest object required

    Client object

  • clientInfo object required
  • clientType integer required

    Default value: 29

  • plan object

    Plan Info

  • planId integer

    Specify planId or PlanName

  • planName string

    Plan Name

  • type string
  • selected boolean
  • subclientInfo object required
  • useLocalContent boolean

    Flag to use local backup content than plan

  • contentOperationType integer
  • content object[]
  • path string

    Buckets in the couchbase cluster. Default is /

  • fsSubClientProp object
  • useGlobalFilters string

    Default value: USE_CELL_LEVEL_POLICY

  • distributedClusterInstanceProperties object required
  • clusterType integer

    Default value: 17

  • opType integer

    Default value: 2

  • instance object
  • instanceName string required

    Name of the couchbase instance

  • clientName string required
  • applicationId integer required

    Default value: 64

  • clusterConfig object required
  • couchbaseConfig object required

    CouchBase

  • port integer

    Port number used to connect couchbase cluster

  • user object

    Credentials of the couchbase admin user

  • userName string

    UserName

  • password string

    Base 64 encoded password

  • staging object required

    Stag

  • stagingType integer

    1 for S3, 0 for file system

  • stagingPath string

    The location of the backup archive directory

  • instanceType integer

    Default value: 5

  • cloudURL string

    s3.[region].amazonaws.com

  • stagingCredentials object

    S3 Account credentials

  • credentialId integer
  • credentialName string
  • dataAccessNodes object

    Couchbase nodes

  • dataAccessNodes object[]

    List of access nodes

  • hostName string
  • clientId integer

    Couchbase node client id

  • clientName string
  • displayName string
  • selected boolean
  • entity object
  • clientName string

    Instance name

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...