getCloudMssqlLogBackupFileList
    • PDF

    getCloudMssqlLogBackupFileList

    • PDF

    Article summary

    Available in VPC

    Get the log backup file list of a Cloud DB for MSSQL instance.

    Commands

    The command statement is as follows.

    ncloud vmssql getCloudMssqlLogBackupFileList [regionCode] [cloudMssqlInstanceNo] [databaseName] [backupSetId] [output]
    

    Parameter

    The following describes the parameters.

    ParameterTypeRequiredDescriptionRestrictions
    regionCodeStringNRegion code
    • regionCode can be obtained through the getRegionList action
    • Default: Select the first Region of the getRegionList query result
    -
    cloudMssqlInstanceNoStringYCloud DB for MSSQL instance number to get backup details for-
    databaseNameStringYDB name-
    backupSetIdStringYBackup ID-
    outputStringNRespond result's format type
    • Options: xml | json
    • Default: json
    -

    Response

    Response data type

    • CloudMssqlLogBackupFileList type

      CloudMssqlLogBackupFileList extends CommonResponseDescription
      private Integer totalRows;Total number of lists searched
      private List<cloudMssqlLogBackupFile> CloudMssqlLogBackupFileList = new ArrayList<>();Cloud DB for MSSQL log backup file list
    • cloudMssqlLogBackupFile type

      cloudMssqlLogBackupFileDescription
      private String fileName;File Name
      private String fullFileName;Full file name
      private Date startTime;Start date and time
      private Date endTime;End date and time
      private Long fileSize;File size

    Examples

    It describes call and response examples.

    Call examples

    The following is a call example.

    ncloud vmssql getCloudMssqlLogBackupFileList --regionCode KR --cloudMssqlInstanceNo ***890 --databaseName msdb --backupSetId 12
    

    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.

    {
      "getCloudMssqlLogBackupFileListResponse": {
          "totalRows":1,
          "cloudMssqlLogBackupFileList": [
              {
                  "fileName": "msdb_20240807_02****.full",
                  "fullFileName": "Z:\\cmssql_backup\\user_idx_276****\\cmssql_10-0-2520_m-3***-001\\msdb_20240807_172525.log",
                  "startTime": "2024-08-07T17:25:25+0900",
                  "endTime": "2024-08-07T17:25:25+0900",
                  "fileSize": 620280
              }
          ],
          "requestId": "93697d3d-****-****-****-953e20c67075",
          "returnCode": "0",
          "returnMessage": "success"
      }
    }
    

    When response result format type (responseFormatType) is XML

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

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMssqlLogBackupFileListResponse>
      <requestId>93697d3d-****-****-****-953e20c67075</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <cloudMssqlLogBackupFileList>
          <CloudMssqlLogBackupFile>
              <fileName>msdb_20240701_02****.full</fileName>
              <fullFileName>Z:\cmssql_backup\user_idx_276****\cmssql_10-0-2520_m-3***-001\msdb_20240807_172525.log</fullFileName>
              <startTime>2024-08-07T17:25:25+0900</startTime>
              <endTime>2024-08-07T17:25:25+0900</endTime>
              <fileSize>620280</fileSize>
          </CloudMssqlLogBackupFile>
      </cloudMssqlLogBackupFileList>
    </getCloudMssqlLogBackupFileListResponse>
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.