getCloudMongoDbBackupDetailList

VPC環境で利用できます。

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

構文

getCloudMongoDbBackupDetailList構文は次の通りです。

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

オプション

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

必須オプション

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

オプション	タイプ	必須の有無	説明
`--cloudMongoDbInstanceNo`	String	Required	Cloud DB for MongoDBインスタンス番号 getCloudMongoDbInstanceListを参照
`--pageSize`	Integer	Conditional	ページごとの項目数 `1`~N `pageNo`入力時、必ず入力

任意オプション

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

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

共通オプション

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

例

Cloud DB for MongoDBバックアップの詳細情報リストの照会リクエストが成功すると、各バックアップの時間、サイズ、識別情報が返されます。

コマンド

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

./ncloud vmongodb getCloudMongoDbBackupDetailList \
    --cloudMongoDbInstanceNo 34567890 \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

出力

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

{
  "getCloudMongoDbBackupDetailListResponse": {
    "totalRows": 1,
    "cloudMongoDbBackupDetailList": [
      {
        "startTime": "2026-06-11T02:00:01+0900",
        "endTime": "2026-06-11T02:00:06+0900",
        "backupSize": 8474,
        "dataStorageSize": 10737418240,
        "shard": "mongodb-01001",
        "objectName": "a1b2c3d4e5f6a7b8c9d0e1f2",
        "backupParallel": 1
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index