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.

Cloud DB for MongoDB (VPC) overview

Prev Next

Available in VPC

Cloud DB for MongoDB is a fully managed cloud database service that allows you to easily build and manage MongoDB databases. Cloud DB for MongoDB provides CLIs for database management features with the vmongodb command.

Common Cloud DB for MongoDB (VPC) settings

This section covers the command and option formats used across the Cloud DB for MongoDB (VPC) CLI.

Syntax

Run vmongodb using the following syntax.

./ncloud vmongodb <subcommand> [options]

Options

The following options are available across all vmongodb subcommands:

Options Type Required Description
--regionCode String Optional Region code
  • KR | SGN | JPN
  • Default: First Region in the getRegionList query results (default).
--output String Optional Format of the response result
  • json (default) | xml

Cloud DB for MongoDB (VPC) commands

The following subcommands are available under vmongodb.

DB Server

The following describes the DB server-related commands:

Commands Description
createCloudMongoDbInstance Create Cloud DB for MongoDB instances.
getCloudMongoDbInstanceList Get Cloud DB for MongoDB instance list.
getCloudMongoDbInstanceDetail Get Cloud DB for MongoDB instance details.
changeCloudMongoDbConfigCount Change the number of config servers for a Cloud DB for MongoDB instance.
changeCloudMongoDbMongosCount Change the number of mongos servers for a Cloud DB for MongoDB instance.
changeCloudMongoDbSecondaryCount Change the number of secondary servers for a Cloud DB for MongoDB instance.
changeCloudMongoDbShardCount Change the number of shards for a Cloud DB for MongoDB instance.
rebootCloudMongoDbServerInstance Restart Cloud DB for MongoDB server instances.
deleteCloudMongoDbInstance Delete Cloud DB for MongoDB instances.

DB User

The following describes the DB user-related commands:

Commands Description
addCloudMongoDbUserList Add a user to a Cloud DB for MongoDB instance.
getCloudMongoDbUserList Get the user list for a Cloud DB for MongoDB instance.
changeCloudMongoDbUserList Edit user information for a Cloud DB for MongoDB instance.
deleteCloudMongoDbUserList Delete a user from a Cloud DB for MongoDB instance.

Backup

The following describes the backup-related commands:

Commands Description
getCloudMongoDbBackupList Get the Cloud DB for MongoDB instance backup list.
getCloudMongoDbBackupDetailList Get the list of Cloud DB for MongoDB instance backup details.
exportBackupToObjectStorage Send Cloud DB for MongoDB instance backup files to Object Storage.

DB Server Log

The following describes the DB server logs-related commands:

Commands Description
getDbServerLogList Get the DB server log list of a Cloud DB for MongoDB instance.
exportDbServerLogToObjectStorage Send DB server log files in a Cloud DB for MongoDB instance to Object Storage.

Common

Use the following common lookup commands when creating resources:

Commands Description
getCloudMongoDbImageProductList Get the list of Cloud DB for MongoDB image product codes.
getCloudMongoDbProductList Get the list of Cloud DB for MongoDB server specification codes.
getCloudMongoDbTargetVpcList Get VPC list.
getCloudMongoDbTargetSubnetList Get subnet list.
getCloudMongoDbBucketList Get Object Storage bucket list.

Cloud DB for MongoDB (VPC) related resources

These resources provide additional context and support for the Cloud DB for MongoDB (VPC) CLI.