getCloudMongoDbBackupList

Available in VPC

Get the backup list of a Cloud DB for MongoDB instance.

Syntax

The getCloudMongoDbBackupList syntax is as follows:

./ncloud vmongodb getCloudMongoDbBackupList \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getCloudMongoDbBackupList.

Required options

The following options are required for getCloudMongoDbBackupList.

Options	Type	Required	Description
`--pageSize`	Integer	Conditional	Number of items per page `1`-N Required when entering `pageNo`.

Optional options

These are the optional options for getCloudMongoDbBackupList. Options that are not specified will use their default values.

Options	Type	Required	Description
`--pageNo`	Integer	Optional	Page number `0`-N

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 the Cloud DB for MongoDB backup list is successful, the backup configuration information for each instance is returned.

Command

The command example is as follows:

./ncloud vmongodb getCloudMongoDbBackupList \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getCloudMongoDbBackupListResponse": {
    "totalRows": 1,
    "cloudMongoDbBackupList": [
      {
        "cloudMongoDbInstanceNo": "34567890",
        "cloudMongoDbServiceName": "mongodb-01",
        "backupFileRetentionPeriod": 1,
        "backupTime": "02:00",
        "backupSize": 8474,
        "lastBackupDate": "2026-06-11T02:00:01+0900"
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index