Skip to main content

Create a MongoDB instance​

This operation is used to create a MongoDB instance.

Request Body
  • clientInfo object
  • clientType string

    Default value: DISTRIBUTED_IDA

    internal field

  • distributedClusterInstanceProperties object
  • instance object
  • instanceId integer required
  • instanceName string required
  • applicationId integer

    Default value: 64

  • clientName string required
  • opType string

    Default value: SET

  • clusterType string

    Default value: MONGODB

  • clusterConfig object
  • mdbConfig object
  • adminUser object required
  • userName string required

    If authentication is enabled on the cluster

  • password string required
  • masterNode object
  • client object
  • clientId integer required

    Master node client ID

  • clientName string required

    Master node client name

  • hostName string required

    Master node hostname

  • portNumber integer required

    Port number of the MongoDB server/Mongos process on the master node

  • osUser string required

    OS user used for impersonation

  • binPath string required

    Path where MongoDB binaries are present on the master node

  • plan object
  • planId integer required
  • planName string required

    Name of the plan associated with the MongoDB instance

  • planType integer
  • planSubtype integer
  • planSummary string
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • entity object
  • clientName string

    Master node client name

Responses

OK

Schema
  • response object
  • errorCode integer
  • entity object
  • clientId integer
  • clientName string
  • instanceId integer
  • _type_ integer
Loading...