Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudMssqlLogFileList

Prev Next

Available in VPC

Get the list of Cloud DB for MSSQL log files.

Commands

The command statement is as follows.

ncloud vmssql getCloudMssqlLogFileList [regionCode] [cloudMssqlInstanceNo] [cloudMssqlServerInstanceNo] [fileType] [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 find log files -
cloudMssqlServerInstanceNo String Y Cloud DB for MSSQL server instance number to find log files -
fileType String Y Log file type
  • e.g., errorLog, agentLog, traceLog, auditLog, xeBaselineLog
-
output String N Respond result's format type
  • Options: xml | json
  • Default: json
-

Response

Response data type

  • CloudMssqlLogFileList type
CloudMssqlLogFileList extends CommonResponse Description
private Integer totalRows; Total number of lists searched
private List<CloudMssqlLogFile> cloudMssqlLogFileList = new ArrayList<>(); Cloud DB for MSSQL log file list
  • CloudMssqlLogFile type
CloudMssqlLogFile Description
private String fileName; Database server log file name
private Long fileSize; Database server log file size
private Date fileDate; Date and time when database server log file was modified

Examples

It describes call and response examples.

Call examples

The following is a call example.

ncloud vmssql getCloudMssqlLogFileList --regionCode KR --cloudMssqlInstanceNo ******2 --cloudMssqlServerInstanceNo *******3 --fileType errorLog

Response example

The following is a sample response.

When the response result format type (output) is JSON

{
  "getCloudMssqlLogFileListResponse": {
    "requestId": "d5e980a0-15b5-4c77-8b12-a70b8673142c",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMssqlLogFileList": [
      {
        "fileName": "ERRORLOG",
        "fileSize": 100000,
        "fileDate": "2022-12-11T06:30:09+0900"
      }
    ]
  }
}

When the response result format type (responseFormatType) is XML

<getCloudMssqlLogFileListResponse>
    <requestId>d5e980a0-15b5-4c77-8b12-a70b8673142c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlLogFileList>
        <cloudMssqlLogFile>
            <fileName>ERRORLOG</fileName>
            <fileSize>100000</fileSize>
            <fileDate>2022-12-11T06:30:09+0900</fileDate>
        </cloudMssqlLogFile>
    </cloudMssqlLogFileList>
</getCloudMssqlLogFileListResponse>