Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudMongoDbInstanceDetail

Prev Next

Available in VPC

Get Cloud DB for MongoDB instance details.

Syntax

The getCloudMongoDbInstanceDetail syntax is as follows:

./ncloud vmongodb getCloudMongoDbInstanceDetail \
    --cloudMongoDbInstanceNo <instance-no> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getCloudMongoDbInstanceDetail.

Required options

The following options are required for getCloudMongoDbInstanceDetail.

Options Type Required Description
--cloudMongoDbInstanceNo String Required Instance number of Cloud DB for MongoDB

Common options

For information about the options common to all vmongodb subcommands, see Cloud DB for MongoDB (VPC) options.

Examples

If the request to retrieve detailed information about a Cloud DB for MongoDB instance is successful, the instance's configuration information and details for each server instance are returned.

Command

The command example is as follows:

./ncloud vmongodb getCloudMongoDbInstanceDetail \
    --cloudMongoDbInstanceNo 34567890 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getCloudMongoDbInstanceDetailResponse": {
    "totalRows": 1,
    "cloudMongoDbInstanceList": [
      {
        "cloudMongoDbInstanceNo": "34567890",
        "cloudMongoDbServiceName": "mongodb-01",
        "cloudMongoDbInstanceStatusName": "running",
        "cloudMongoDbInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE (VPC) Created status"
        },
        "cloudMongoDbInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "generationCode": "G2",
        "clusterType": {
          "code": "SHARDED_CLUSTER",
          "codeName": "Sharding Cluster Type - Cloud DB for MongoDB (VPC)"
        },
        "engineVersion": "MongoDB 7.0.28 Community Edition",
        "licence": {
          "code": "OEM",
          "codeName": "License code - CLOUD DATABASE (VPC)"
        },
        "backupFileRetentionPeriod": 1,
        "backupTime": "02:00",
        "backupParallel": 1,
        "cloudMongoDbImageProductCode": "SW.VMGDB.OS.LNX64.ROCKY.0810.MNGDB.CE.B050",
        "accessControlGroupNoList": [
          "67890123"
        ],
        "shardCount": 2,
        "compress": {
          "code": "SNPP",
          "codeName": "Snappy"
        },
        "memberPort": 17017,
        "arbiterPort": 17017,
        "mongosPort": 17017,
        "configPort": 17017,
        "createDate": "2026-06-10T10:03:36+0900",
        "cloudMongoDbServerInstanceList": [
          {
            "cloudMongoDbServerInstanceNo": "34567895",
            "cloudMongoDbServerName": "mg-mongodb-ab001-98eb",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "AB",
              "codeName": "Arbiter"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:09:52+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0005.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3419908095,
            "cloudMongoDbProductCode": "SVR.VMGDB.ARBIT.HICPU.C002.M004.NET.SSD.B050.G002",
            "replicaSetName": "mongodb-01001",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMongoDbServerInstanceNo": "34567896",
            "cloudMongoDbServerName": "mg-mongodb-ab002-98ec",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "AB",
              "codeName": "Arbiter"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:09:52+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0006.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3419789993,
            "cloudMongoDbProductCode": "SVR.VMGDB.ARBIT.HICPU.C002.M004.NET.SSD.B050.G002",
            "replicaSetName": "mongodb-01002",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMongoDbServerInstanceNo": "34567899",
            "cloudMongoDbServerName": "mg-mongodb-c-98ef",
            "clusterRole": {
              "code": "CONFIG_SERVER",
              "codeName": "Config Server Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "C",
              "codeName": "Config Server"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:10:22+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0009.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3422415530,
            "cloudMongoDbProductCode": "SVR.VMGDB.CFGSV.HICPU.C002.M004.NET.SSD.B050.G002",
            "replicaSetName": "csmongodb-01",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMongoDbServerInstanceNo": "34567900",
            "cloudMongoDbServerName": "mg-mongodb-c-98eg",
            "clusterRole": {
              "code": "CONFIG_SERVER",
              "codeName": "Config Server Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "C",
              "codeName": "Config Server"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:10:01+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0010.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3421756076,
            "cloudMongoDbProductCode": "SVR.VMGDB.CFGSV.HICPU.C002.M004.NET.SSD.B050.G002",
            "replicaSetName": "csmongodb-01",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMongoDbServerInstanceNo": "34567901",
            "cloudMongoDbServerName": "mg-mongodb-c-98eh",
            "clusterRole": {
              "code": "CONFIG_SERVER",
              "codeName": "Config Server Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "C",
              "codeName": "Config Server"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:09:01+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0011.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3421812050,
            "cloudMongoDbProductCode": "SVR.VMGDB.CFGSV.HICPU.C002.M004.NET.SSD.B050.G002",
            "replicaSetName": "csmongodb-01",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMongoDbServerInstanceNo": "34567891",
            "cloudMongoDbServerName": "mg-mongodb-mb001-98e7",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "MB",
              "codeName": "Member"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:10:07+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0001.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3421857790,
            "cloudMongoDbProductCode": "SVR.VMGDB.MNGOD.HICPU.C002.M004.NET.SSD.B050.G002",
            "replicaSetName": "mongodb-01001",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMongoDbServerInstanceNo": "34567892",
            "cloudMongoDbServerName": "mg-mongodb-mb001-98e8",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "MB",
              "codeName": "Member"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:09:56+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0002.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3421469356,
            "cloudMongoDbProductCode": "SVR.VMGDB.MNGOD.HICPU.C002.M004.NET.SSD.B050.G002",
            "replicaSetName": "mongodb-01001",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMongoDbServerInstanceNo": "34567893",
            "cloudMongoDbServerName": "mg-mongodb-mb002-98e9",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "MB",
              "codeName": "Member"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:09:51+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0003.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3421216770,
            "cloudMongoDbProductCode": "SVR.VMGDB.MNGOD.HICPU.C002.M004.NET.SSD.B050.G002",
            "replicaSetName": "mongodb-01002",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMongoDbServerInstanceNo": "34567894",
            "cloudMongoDbServerName": "mg-mongodb-mb002-98ea",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "MB",
              "codeName": "Member"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:09:23+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0004.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3421128702,
            "cloudMongoDbProductCode": "SVR.VMGDB.MNGOD.HICPU.C002.M004.NET.SSD.B050.G002",
            "replicaSetName": "mongodb-01002",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMongoDbServerInstanceNo": "34567897",
            "cloudMongoDbServerName": "mg-mongodb-rt-98ed",
            "clusterRole": {
              "code": "MONGOS",
              "codeName": "Mongos Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "RT",
              "codeName": "Mongos"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:09:33+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0007.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3104399356,
            "cloudMongoDbProductCode": "SVR.VMGDB.MNGOS.HICPU.C002.M004.NET.SSD.B050.G002",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMongoDbServerInstanceNo": "34567898",
            "cloudMongoDbServerName": "mg-mongodb-rt-98ee",
            "clusterRole": {
              "code": "MONGOS",
              "codeName": "Mongos Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "RT",
              "codeName": "Mongos"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "createDate": "2026-06-10T10:03:36+0900",
            "uptime": "2026-06-10T10:10:21+0900",
            "zoneCode": "KR-1",
            "privateDomain": "mg0008.vpc.mg.naverncp.com",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 3104520876,
            "cloudMongoDbProductCode": "SVR.VMGDB.MNGOS.HICPU.C002.M004.NET.SSD.B050.G002",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          }
        ]
      }
    ],
    "requestId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "returnCode": "0",
    "returnMessage": "success"
  }
}