getCloudMssqlLogFileList

Prev Next

Available in VPC

Get the list of Cloud DB for MSSQL log files available.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET, POST /getCloudMssqlLogFileList

Request headers

For information about the headers common to all Cloud DB for MSSQL (VPC) APIs, see Cloud DB for MSSQL (VPC) request headers.

Request parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code of the Cloud DB for MSSQL instance to view
  • Check through getRegionList
  • First Region of the getRegionList query result (default)
cloudMssqlInstanceNo String Required Cloud DB for MSSQL instance number
cloudMssqlServerInstanceNo String Required Cloud DB for MSSQL server instance number
fileType String Required Log file type
  • errorLog | agentLog | traceLog | auditLog | xeBaselineLog
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlLogFileList
?regionCode=KR
&cloudMssqlInstanceNo=2522****
&cloudMssqlServerInstanceNo=2528****
&fileType=agentLog
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

See CloudMssqlLogFileList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The response example is as follows:

  • If responseFormetType=json

    {
    "getCloudMssqlLogFileListResponse": {
        "totalRows": 4,
        "cloudMssqlLogFileList": [
            {
                "fileName": "SQLAGENT.OUT",
                "fileSize": 3164,
                "fileDate": "2024-07-01T14:58:13+0900"
            },
            {
                "fileName": "SQLAGENT.1",
                "fileSize": 4428,
                "fileDate": "2024-07-01T14:58:06+0900"
            },
            {
                "fileName": "SQLAGENT.2",
                "fileSize": 4172,
                "fileDate": "2024-07-01T14:56:23+0900"
            },
            {
                "fileName": "SQLAGENT.3",
                "fileSize": 4312,
                "fileDate": "2024-07-01T14:54:11+0900"
            }
        ],
        "requestId": "dd99ccc0-****-****-****-f002e46ceb43",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

  • If responseFormetType=xml (default)

    <?xml version="1.0" encoding="UTF-8"?>
<getCloudMssqlLogFileListResponse>
    <requestId>dd99ccc0-****-****-****-f002e46ceb43</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>4</totalRows>
    <cloudMssqlLogFileList>
        <cloudMssqlLogFile>
            <fileName>SQLAGENT.OUT</fileName>
            <fileSize>3164</fileSize>
            <fileDate>2024-07-01T14:58:13+0900</fileDate>
        </cloudMssqlLogFile>
        <cloudMssqlLogFile>
            <fileName>SQLAGENT.1</fileName>
            <fileSize>4428</fileSize>
            <fileDate>2024-07-01T14:58:06+0900</fileDate>
        </cloudMssqlLogFile>
        <cloudMssqlLogFile>
            <fileName>SQLAGENT.2</fileName>
            <fileSize>4172</fileSize>
            <fileDate>2024-07-01T14:56:23+0900</fileDate>
        </cloudMssqlLogFile>
        <cloudMssqlLogFile>
            <fileName>SQLAGENT.3</fileName>
            <fileSize>4312</fileSize>
            <fileDate>2024-07-01T14:54:11+0900</fileDate>
        </cloudMssqlLogFile>
    </cloudMssqlLogFileList>
</getCloudMssqlLogFileListResponse>