getCloudMssqlBackupDetailList

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in VPC

Get a list of available Cloud DB for MSSQL backup details.

Commands

The command statement is as follows.

ncloud vmssql getCloudMssqlBackupDetailList [regionCode] [cloudMssqlInstanceNo] [pageNo] [pageSize] [output]

Parameter

The following describes the parameters.

Parameter	Type	Required	Description	Restrictions
regionCode	String	N	Region code regionCode can be obtained through the getRegionList action Default: Select the first Region of the getRegionList query result	-
cloudMssqlInstanceNo	String	Y	Cloud DB for MSSQL instance number to get backup details for cloudMssqlInstanceNo can be obtained through the getCloudMssqlInstanceList action	-
pageNo	Integer	N	Page numbers in paged results The results can be paged using pageNo and pageSize	- Min: 0
pageSize	Integer	N	Size of each page to display when paging The results can be paged using pageNo and pageSize Required when entering pageNo	- Min: 1
output	String	N	Respond result's format type Options: xml \| json Default: json	-

Response

Response data type

CloudMssqlBackupDetailList type

CloudMssqlBackupDetailList extends CommonResponse	Description
private Integer totalRows;	Total number of lists searched
private List<CloudMssqlBackupDetail> cloudMssqlBackupDetailList = new ArrayList<>();	Cloud DB for MSSQL backup details list

CloudMssqlBackupDetail type

CloudMssqlBackupDetail	Description
private Integer backupSetId;	Backup ID
private String databaseName;	DB name
private String fileName;	File Name
private String fullFileName;	Full file name
private Long fullBackupSize;	FullBackup data size
private Long logBackupCount;	Number of related log backups
private Long logBackupSize;	Related log backup data size
private Date startTime;	Backup start date and time
private Date endTime;	Backup end date and time

Examples

It describes call and response examples.

Call examples

The following is a call example.

ncloud vmssql getCloudMssqlBackupDetailList --regionCode KR --cloudMssqlInstanceNo ***890

Response example

The following is a sample response.

When response result format type (output) is JSON

The following is an example when the response result format type (output) is JSON.

{
  "getCloudMssqlBackupDetailListResponse": {
    "requestId": "f3bda8a3-978a-42d3-b52f-123b096e0f45",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 4,
    "cloudMssqlBackupDetailList": [
      {
        "backupSetId": 12,
        "databaseName": "master",
        "fileName": "sample.txt",
        "fullFileName": "D:\\sample.txt",        
        "fullBackupSize": 780145,
        "logBackupCount": 0,
        "logBackupSize": 0,
        "startTime": "2021-07-12T09:13:57+0900",
        "endTime": "2021-07-12T09:13:57+0900"
      },
      {
        "backupSetId": 13,
        "databaseName": "msdb",
        "fileName": "sample1.txt",
        "fullFileName": "D:\\sample1.txt",        
        "fullBackupSize": 2590649,
        "logBackupCount": 0,
        "logBackupSize": 0,
        "startTime": "2021-07-12T09:13:51+0900",
        "endTime": "2021-07-12T09:13:51+0900"
      },
      {
        "backupSetId": 14,
        "databaseName": "master",
        "fileName": "sample2.txt",
        "fullFileName": "D:\\sample2.txt",        
        "fullBackupSize": 780204,
        "logBackupCount": 0,
        "logBackupSize": 0,
        "startTime": "2021-07-11T09:14:18+0900",
        "endTime": "2021-07-11T09:14:18+0900"
      },
      {
        "backupSetId": 15,
        "databaseName": "msdb",
        "fileName": "sample3.txt",
        "fullFileName": "D:\\sample3.txt",        
        "fullBackupSize": 2589526,
        "logBackupCount": 0,
        "logBackupSize": 0,
        "startTime": "2021-07-11T09:14:12+0900",
        "endTime": "2021-07-11T09:14:13+0900"
      }
    ]
  }
}

When response result format type (responseFormatType) is XML

The following is an example when the response result format type (responseFormatType) is XML.

<getCloudMssqlBackupDetailListResponse>
    <requestId>f3bda8a3-978a-42d3-b52f-123b096e0f45</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>4</totalRows>
    <cloudMssqlBackupDetailList>
        <CloudMssqlBackupDetail>
            <backupSetId>12</backupSetId>
            <databaseName>master</databaseName>
            <fileName>sample.txt</fileName>
            <fullFileName>D:\\sample.txt</fullFileName>
            <fullBackupSize>780145</fullBackupSize>
            <logBackupCount>0</logBackupCount>
            <logBackupSize>0</logBackupSize>
            <startTime>2021-07-12T09:13:57+0900</startTime>
            <endTime>2021-07-12T09:13:57+0900</endTime>
        </CloudMssqlBackupDetail>
        <CloudMssqlBackupDetail>
            <backupSetId>13</backupSetId>
            <databaseName>msdb</databaseName>
            <fileName>sample1.txt</fileName>
            <fullFileName>D:\\sample1.txt</fullFileName>
            <fullBackupSize>2590649</fullBackupSize>
            <logBackupCount>0</logBackupCount>
            <logBackupSize>0</logBackupSize>
            <startTime>2021-07-12T09:13:51+0900</startTime>
            <endTime>2021-07-12T09:13:51+0900</endTime>
        </CloudMssqlBackupDetail>
        <CloudMssqlBackupDetail>
            <backupSetId>14</backupSetId>
            <databaseName>master</databaseName>
            <fileName>sample2.txt</fileName>
            <fullFileName>D:\\sample2.txt</fullFileName>
            <fullBackupSize>780204</fullBackupSize>
            <logBackupCount>0</logBackupCount>
            <logBackupSize>0</logBackupSize>
            <startTime>2021-07-11T09:14:18+0900</startTime>
            <endTime>2021-07-11T09:14:18+0900</endTime>
        </CloudMssqlBackupDetail>
        <CloudMssqlBackupDetail>
            <backupSetId>15</backupSetId>
            <databaseName>msdb</databaseName>
            <fileName>sample3.txt</fileName>
            <fullFileName>D:\\sample3.txt</fullFileName>
            <fullBackupSize>2589526</fullBackupSize>
            <logBackupCount>0</logBackupCount>
            <logBackupSize>0</logBackupSize>
            <startTime>2021-07-11T09:14:12+0900</startTime>
            <endTime>2021-07-11T09:14:13+0900</endTime>
        </CloudMssqlBackupDetail>
    </cloudMssqlBackupDetailList>
</getCloudMssqlBackupDetailListResponse>

Documentation Index