---
title: "CloudMongoDbInstance"
slug: "common-vapidatatype-cloudmongodbinstance"
updated: 2026-09-17T09:25:09Z
published: 2026-09-17T09:25:09Z
canonical: "api.ncloud-docs.com/common-vapidatatype-cloudmongodbinstance"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CloudMongoDbInstance

Available in VPC

This is a Cloud DB for MongoDB instance.

## Syntax

The syntax is as follows.

```
private String cloudMongoDbInstanceNo;
private String cloudMongoDbServiceName;
private String cloudMongoDbInstanceStatusName;
private CommonCode cloudMongoDbInstanceStatus;
private CommonCode cloudMongoDbInstanceOperation;
private String generationCode;
private CommonCode clusterType;
private String engineVersion;
private CommonCode licence;
private Integer backupFileRetentionPeriod;
private String backupTime;
private String cloudMongoDbImageProductCode;
private AccessControlGroupNoList accessControlGroupNoList;
private Integer shardCount;
private CommonCode compress;
private Integer memberPort;
private Integer arbiterPort;
private Integer mongosPort;
private Integer configPort;
private Date createDate;
private List<CloudMongoDbServerInstance> cloudMongoDbServerInstanceList;
```

## Field

The following describes the fields.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cloudMongoDbInstanceNo` | String | Required | Cloud DB for MongoDB instance number |
| `cloudMongoDbServiceName` | String | Required | Cloud DB for MongoDB service name |
| `cloudMongoDbInstanceStatusName` | String | Required | Cloud DB for MongoDB instance status name - `creating` \| `deleted` \| `deleting` \| `downgrading` \| `pending` \| `recovering` \| `reinstalling` \| `restarting` \| `running` \| `settingup` \| `shuttingdown` \| `stopped` \| `upgrading` |
| `cloudMongoDbInstanceStatus` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Required | Cloud DB for MongoDB instance status - `INIT` \| `CREAT` \| `DEL` - `INIT`: initiated - `CREAT`: created - `DEL`: deleted |
| `cloudMongoDbInstanceOperation` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Required | Cloud DB for MongoDB instance operation status - `CREAT` \| `DEL` \| `FO` \| `NULL` \| `SETUP` \| `UPGD` \| `DWGD` \| `BKP` - `CREAT`: create - `DEL`: delete - `FO`: failover - `NULL`: no operation - `SETUP`: setup - `UPGD`: upgrade - `DWGD`: downgrade - `BKP`: backup |
| `generationCode` | String | Required | Server generation code |
| `clusterType` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Optional | Cloud DB for MongoDB cluster type |
| `engineVersion` | String | Optional | Cloud DB for MongoDB engine version |
| `license` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Optional | Cloud DB for MongoDB license |
| `backupFileRetentionPeriod` | Integer | Optional | Backup file retention period |
| `backupTime` | String | Optional | Backup time |
| `cloudMongoDbImageProductCode` | String | Optional | Cloud DB for MongoDB image product code |
| `accessControlGroupNoList` | [AccessControlGroupNoList](/docs/en/common-vapidatatype-accesscontrolgroupnolist) | Optional | ACG number list |
| `shardCount` | Integer | Optional | Number of shards for Cloud DB for MongoDB |
| `compress` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Optional | Cloud DB for MongoDB data compression algorithm |
| `memberPort` | Integer | Optional | Cloud DB for MongoDB member server port |
| `arbiterPort` | Integer | Optional | Cloud DB for MongoDB arbiter server port |
| `mongosPort` | Integer | Optional | Cloud DB for MongoDB mongos server port |
| `configPort` | Integer | Optional | Cloud DB for MongoDB config server port |
| `createDate` | Date | Optional | Creation date and time |
| `cloudMongoDbServerInstanceList` | List<[CloudMongoDbServerInstance](/docs/en/common-vapidatatype-cloudmongodbserverinstance)> | Required | Cloud DB for MongoDB server instance list |