getCloudMssqlBackupList

Available in VPC

Views a backup list of available Cloud DB for MSSQL

Commands

The text of the command is as follows:

ncloud vmssql getCloudMssqlBackupList [regionCode] [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	-
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

CloudMssqlBackupList type

CloudMssqlBackupList extends CommonResponse	Description
private Integer totalRows;	Total number of items viewed
private List<CloudMssqlBackup> cloudMssqlBackupList = new ArrayList<>();	Cloud DB for MSSQL backup list

CloudMssqlBackup type

CloudMssqlBackup	Description
private Integer cloudMssqlInstanceNo;	Cloud DB for MSSQL instance number
private String cloudMssqlServiceName;	Cloud DB for MSSQL service name
private Integer backupFileRetentionPeriod;	Backup file storage period
private String backupTime;	FullBackup start time
private Long totalBackupDataSize;	Backup data size in storage
private Long fullBackupDataSize;	FullBackup data size
private Long logBackupDataSize;	Log backup data size
private Long logBackupCount;	Number of log backups

Examples

Describes examples of recalls and responses.

Recall examples

The following are examples of recalls.

ncloud vmssql getCloudMssqlBackupList --regionCode KR

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.

{
  "getCloudMssqlBackupListResponse": {
    "requestId": "d5e980a0-15b5-4c77-8b12-a70b8673142c",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMssqlBackupList": [
      {
        "cloudMssqlInstanceNo": "****890",
        "cloudMssqlServiceName": "test-****",
        "backupDurationDay": 3,
        "backupTime": "17:00",
        "totalBackupDataSize": 20252685,
        "fullBackupDataSize": 20252685,
        "logBackupDataSize": 0,
        "logBackupCount": 0
      }
    ]
  }
}

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

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

<getCloudMssqlBackupListResponse>
    <requestId>d5e980a0-15b5-4c77-8b12-a70b8673142c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlBackupList>
        <CloudMssqlBackup>
            <cloudMssqlInstanceNo>****890</cloudMssqlInstanceNo>
            <cloudMssqlServiceName>test-****</cloudMssqlServiceName>
            <backupDurationDay>3</backupDurationDay>
            <backupTime>17:00</backupTime>
            <totalBackupDataSize>20252685</totalBackupDataSize>
            <fullBackupDataSize>20252685</fullBackupDataSize>
            <logBackupDataSize>0</logBackupDataSize>
            <logBackupCount>0</logBackupCount>
        </CloudMssqlBackup>
    </cloudMssqlBackupList>
</getCloudMssqlBackupListResponse>