getHourlyTrafficUsageList

Prev Next

Available in Classic

Get the peak hourly traffic usage generated by Secure Zone Firewall.

Request

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

Method URI
POST /{type}/{zone}/getHourlyTrafficUsageList

Request headers

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

Request path parameters

The following describes the parameters.

Field Type Required Description
type String Required firewall type provided by Secure Zone
  • szfw | psfw
    • szfw: Secure Zone Standard
    • psfw: Secure Zone Advanced
zone String Required Zone in which Secure Zone is configured
  • kr1 | kr2
    • kr1: KR-1 zone
    • kr2: KR-2 zone

Request body

The following describes the request body.

Field Type Required Description
status String Optional User's status
  • USE | END
page Integer Optional Page index
  • 0 (default)
countPerPage Integer Optional Number of items per page
  • 0 (default)
fromDate Date Required Start date of the query period
toDate Date Required End date of the query period
timeZone String Optional Time 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/getHourlyTrafficUsageList'
--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 '{
  "status": "USE",
  "page": 0,
  "countPerPage": 20,
  "fromDate": "2024-07-01T00:32:14.953Z",
  "toDate": "2024-07-02T00:32:14.953Z",
  "timeZone": "+09:00"
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Required Description
action String - Request type
returnCode Integer - Response code
returnMessage String - Response message
trafficUsageList[] Array - List of traffic usage data
trafficUsageList[].memberNo String - User's NAVER Cloud Platform member ID
trafficUsageList[].instanceNo String - Contract number assigned when creating the instance
trafficUsageList[].secureZoneName String - Secure Zone name
trafficUsageList[].checkDate String - Inspection date (yyyy-MM-dd)
trafficUsageList[].checkTime String - Inspection hour (hh:mm:ss)
trafficUsageList[].checkHour String - Inspection time (hh)
trafficUsageList[].checkDateTime Long - Traffic registration date (Unix timestamp)
trafficUsageList[].peakTraffic Long - Maximum traffic
trafficUsageList[].regYmdt Date - Not use
trafficUsageList[].status String - User's status
trafficUsageList[].memberLastModifyYmdt Long - Last modification date of user information (Unix timestamp)
totalCount Integer - 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": "getHourlyTrafficUsage",
    "returnCode": 0,
    "returnMessage": "success",
    "trafficUsageList": [
        {
            "memberNo": "27***85",
            "instanceNo": "25****11",
            "secureZoneName": "Secure",
            "checkDate": "2024-07-03",
            "checkTime": "13:40:12",
            "checkHour": "13",
            "checkDateTime": 1719981612000,
            "peakTraffic": 0,
            "regYmdt": null,
            "status": "USE",
            "memberLastModifyYmdt": 1719379274000
        },
        {
            "memberNo": "27***85",
            "instanceNo": "25****11",
            "secureZoneName": "Secure",
            "checkDate": "2024-07-03",
            "checkTime": "14:00:16",
            "checkHour": "14",
            "checkDateTime": 1719982816000,
            "peakTraffic": 277,
            "regYmdt": null,
            "status": "USE",
            "memberLastModifyYmdt": 1719379274000
        }
    ],
    "totalCount": 2
}