MENU
      getTrafficUsage

        getTrafficUsage


        Article summary

        Available in Classic

        Get traffic usage 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}/getTrafficUsage

        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
        statusStringOptionalUser's status
        • USE | END
        pageIntegerOptionalPage index
        • 0 (default)
        countPerPageIntegerOptionalNumber of items per page
        • 0 (default)
        fromDateDateRequiredStart date of the query period
        toDateDateRequiredEnd date of the query period
        timeZoneStringOptionalTime zone
        • +09:00 (default)

        Request example

        The following is a sample request.

        curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr2/getTrafficUsage'
        --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-03T05:32:24.223Z"
        }'
        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
        trafficUsageList[]Array-List of traffic usage data
        trafficUsageList[].memberNoString-User's NAVER Cloud Platform member ID
        trafficUsageList[].instanceNoString-Contract number assigned when creating the instance
        trafficUsageList[].secureZoneNameString-Secure Zone name
        trafficUsageList[].checkDateString-Inspection date (yyyy-MM-dd)
        trafficUsageList[].checkTimeString-Inspection hour (hh:mm:ss)
        trafficUsageList[].checkHourString-Inspection time (hh)
        trafficUsageList[].rxBytesInteger-Received data size
        trafficUsageList[].txBytesInteger-Sent data size
        trafficUsageList[].rxBytesIncrementInteger-Increase in data received
        trafficUsageList[].txBytesIncrementInteger-Increase in data sent
        trafficUsageList[].totalIncrementInteger-Total increase in data
        trafficUsageList[].regYmdtDate-Registration Date
        trafficUsageList[].statusString-User's status
        trafficUsageList[].memberLastModifyYmdtDate-Last modified date of user information
        totalCountInteger-Traffic usage data count

        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": "getTrafficUsage",
            "returnCode": 0,
            "returnMessage": "success",
            "trafficUsageList": [
                {
                    "memberNo": "27***85",
                    "instanceNo": "25****11",
                    "secureZoneName": "Secure",
                    "checkDate": "2024-07-01",
                    "checkTime": "09:40:13",
                    "checkHour": "09",
                    "rxBytes": 0,
                    "txBytes": 752,
                    "rxBytesIncrement": 0,
                    "txBytesIncrement": 0,
                    "totalIncrement": 277,
                    "regYmdt": 1719794413000,
                    "status": "USE",
                    "memberLastModifyYmdt": 1719379274000
                }
            ],
            "totalCount": 318
        }
        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.