getCloudMongoDbBackupList

VPC環境で利用できます。

Cloud DB for MongoDBインスタンスのバックアップリストを照会します。

構文

getCloudMongoDbBackupList構文は次の通りです。

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

オプション

getCloudMongoDbBackupListの実行時に指定できるオプションについて説明します。

必須オプション

getCloudMongoDbBackupListの必須オプションです。

オプション	タイプ	必須の有無	説明
`--pageSize`	Integer	Conditional	ページごとの項目数 `1`~N `pageNo`入力時、必ず入力

任意オプション

getCloudMongoDbBackupListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション	タイプ	必須の有無	説明
`--pageNo`	Integer	Optional	ページ番号 `0`~N

共通オプション

vmongodbコマンドで共通して使用するオプションについては、Cloud DB for MongoDB (VPC)のオプションを参照してください

例

Cloud DB for MongoDBバックアップリストの照会リクエストが成功すると、各インスタンスのバックアップ設定情報が返されます。

コマンド

コマンドの例は次の通りです。

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

出力

出力の例は次の通りです。

{
  "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