getCloudMssqlBackupDetailList

Article Summary

Share feedback

Thanks for sharing your feedback!

Available in VPC

Views a list of available Cloud DB for MSSQL backup details

Commands

The text of the command is as follows:

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

Parameter

The following is a description on parameters.

Parameter	Type	Requirement status	Description	Restrictions
regionCode	String	N	Region code - regionCode can be obtained via the getRegionList action - Default: selects the first region of the getRegionList search results	-
cloudMssqlInstanceNo	String	Y	Cloud DB for MSSQL instance number of which backup details are to be viewed - cloudMssqlInstanceNo can be obtained via the getCloudMssqlInstanceList action	-
pageNo	Integer	N	Page number of paged results - The results can be paged using pageNo and pageSize	- Min: 0
pageSize	Integer	N	Size of each page to be shown during paging - The results can be paged using pageNo and pageSize - Must be entered when entering pageNo	- Min: 1
output	String	N	Format type of the response result - options: xml \| json - default: json	-

Responses

Response data type

CloudMssqlBackupDetailList type

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

CloudMssqlBackupDetail type

CloudMssqlBackupDetail	Description
private String databaseName;	DB 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

Describes examples of recalls and responses.

Recall examples

The following are examples of recalls.

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

Response examples

The following are examples of responses.

If the response shows that format type (output) is json

The following is when the response shows that format type (output) is json.

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

If the response shows that format type (responseFormatType) is xml

The following is when the response shows that format type (responseFormatType) is xml:

<getCloudMssqlBackupDetailListResponse>
    <requestId>f3bda8a3-978a-42d3-b52f-123b096e0f45</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>4</totalRows>
    <cloudMssqlBackupDetailList>
        <CloudMssqlBackupDetail>
            <databaseName>master</databaseName>
            <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>
            <databaseName>msdb</databaseName>
            <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>
            <databaseName>master</databaseName>
            <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>
            <databaseName>msdb</databaseName>
            <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>

Was this article helpful?

What's Next

getCloudMssqlBackupList

Table of contents

Commands
Responses
Examples