MENU
      getTrafficLog

        getTrafficLog


        Article summary

        Available in Classic

        Get traffic logs generated by Secure Zone Firewall.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        POST/{type}/{zone}/getTrafficLog

        Request headers

        For headers common to Secure Zone APIs, see Secure Zone request headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        typeStringRequiredfirewall type provided by Secure Zone
        • szfw | psfw
          • szfw: Secure Zone Standard
          • psfw: Secure Zone Advanced
        zoneStringRequiredZone in which Secure Zone is configured
        • kr1 | kr2
          • kr1: KR-1 zone
          • kr2: KR-2 zone

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        actionStringOptionalAllow/deny
        • allow | deny
        countPerPageIntegerOptionalNumber of items per page
        • 0 (default)
        pageIntegerOptionalPage index
        • 0 (default)
        fromDateDateRequiredStart date of the query period
        toDateDateRequiredEnd date of the query period
        timeZoneStringOptionalTime zone
        • +09:00 (default)
        destinationIpStringOptionalDestination IP address
        portStringOptionalDestination port number
        protocolStringOptionalDestination protocol
        sourceIpStringOptionalOrigin IP address

        Request example

        The following is a sample request.

        curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr2/getTrafficLog'
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'x-ncp-mbr_no: {User number}' \
        --header 'Content-Type: application/json' \
        --data '{
          "fromDate": "2024-07-01T00:32:14.953Z",
          "toDate": "2024-07-03T04:59:58.525Z"
        }'
        Curl

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        actionString-Request type
        returnCodeInteger-Response code
        returnMessageString-Response message
        totalCountInteger-Total number of traffic logs
        trafficLogList[]Array-Traffic log information
        trafficLogList[].receiveDateLong-Log occurrence date (Unix timestamp)
        trafficLogList[].sourceIpString-Origin IP address
        trafficLogList[].sourceServerNameString-Origin server name
        trafficLogList[].destinationIpString-Destination IP address
        trafficLogList[].destinationServerNameString-Destination server name
        trafficLogList[].protocolString-Destination protocol
        trafficLogList[].serviceString-Service
        trafficLogList[].portString-Destination port number
        trafficLogList[].actionString-Allow/deny
        • allow | deny
        trafficLogList[].policyNameString-Policy name

        Response status codes

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

        Response example

        The following is a sample example.

        {
            "action": "getTrafficLog",
            "returnCode": 0,
            "returnMessage": "success",
            "totalCount": 5,
            "trafficLogList": [
                {
                    "receiveDate": 1719982292000,
                    "sourceIp": "***.***.***.***",
                    "sourceServerName": "",
                    "destinationIp": "***.***.***.***",
                    "destinationServerName": "sv-securezone",
                    "protocol": "TCP",
                    "service": "SSH",
                    "port": "22",
                    "action": "deny",
                    "policyName": "Policy(Default Deny)"
                },
                {
                    "receiveDate": 1719982286000,
                    "sourceIp": "***.***.***.***",
                    "sourceServerName": "",
                    "destinationIp": "***.***.***.***",
                    "destinationServerName": "sv-securezone",
                    "protocol": "TCP",
                    "service": "SSH",
                    "port": "22",
                    "action": "deny",
                    "policyName": "Policy(Default Deny)"
                },
                {
                    "receiveDate": 1719982282000,
                    "sourceIp": "***.***.***.***",
                    "sourceServerName": "",
                    "destinationIp": "***.***.***.***",
                    "destinationServerName": "sv-securezone",
                    "protocol": "TCP",
                    "service": "SSH",
                    "port": "22",
                    "action": "deny",
                    "policyName": "Policy(Default Deny)"
                },
                {
                    "receiveDate": 1719982281000,
                    "sourceIp": "***.***.***.***",
                    "sourceServerName": "",
                    "destinationIp": "***.***.***.***",
                    "destinationServerName": "sv-securezone",
                    "protocol": "TCP",
                    "service": "SSH",
                    "port": "22",
                    "action": "deny",
                    "policyName": "Policy(Default Deny)"
                },
                {
                    "receiveDate": 1719982279000,
                    "sourceIp": "***.***.***.***",
                    "sourceServerName": "",
                    "destinationIp": "***.***.***.***",
                    "destinationServerName": "sv-securezone",
                    "protocol": "TCP",
                    "service": "SSH",
                    "port": "22",
                    "action": "deny",
                    "policyName": "Policy(Default Deny)"
                }
            ]
        }
        JSON

        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.