getCloudMssqlBackupDetailList

Available in VPC

Get Cloud DB for MSSQL instance backup details in a list.

Syntax

The getCloudMssqlBackupDetailList syntax is as follows:

./ncloud vmssql getCloudMssqlBackupDetailList \
    --cloudMssqlInstanceNo <instance-no> \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getCloudMssqlBackupDetailList.

Required options

The following options are required for getCloudMssqlBackupDetailList.

Options	Type	Required	Description
`--cloudMssqlInstanceNo`	String	Required	Cloud DB for MSSQL instance number See getCloudMssqlInstanceList.
`--pageSize`	Integer	Conditional	Number of items per page Required when entering `pageNo`.

Optional options

These are the optional options for getCloudMssqlBackupDetailList. 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 vmssql subcommands, see Cloud DB for MSSQL (VPC) options.

Examples

If the request to retrieve detailed information about Cloud DB for MSSQL backups is successful, the identification information, backup time, and backup size for each backup file are returned.

Command

The command example is as follows:

./ncloud vmssql getCloudMssqlBackupDetailList \
    --cloudMssqlInstanceNo 25280088 \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getCloudMssqlBackupDetailListResponse": {
    "totalRows": 2,
    "cloudMssqlBackupDetailList": [
      {
        "backupSetId": 2,
        "databaseName": "master",
        "fileName": "master_20260609_202343.full",
        "fullFileName": "Z:\\cmssql_backup\\user_idx_0000000\\cmssql_10-0-0-6_m-25280088-001\\master_20260609_202343.full",
        "fullBackupSize": 872566,
        "logBackupCount": 0,
        "logBackupSize": 0,
        "startTime": "2026-06-09T20:23:43+0900",
        "endTime": "2026-06-09T20:23:43+0900"
      },
      {
        "backupSetId": 1,
        "databaseName": "msdb",
        "fileName": "msdb_20260609_202338.full",
        "fullFileName": "Z:\\cmssql_backup\\user_idx_0000000\\cmssql_10-0-0-6_m-25280088-001\\msdb_20260609_202338.full",
        "fullBackupSize": 3224782,
        "logBackupCount": 0,
        "logBackupSize": 0,
        "startTime": "2026-06-09T20:23:38+0900",
        "endTime": "2026-06-09T20:23:38+0900"
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index