getTrafficUsage
- Print
- PDF
getTrafficUsage
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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:
| Method | URI |
|---|---|
| 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.
| Field | Type | Required | Description |
|---|---|---|---|
type | String | Required | firewall type provided by Secure Zone
|
zone | String | Required | Zone in which Secure Zone is configured
|
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
status | String | Optional | User's status
|
page | Integer | Optional | Page index
|
countPerPage | Integer | Optional | Number of items per page
|
fromDate | Date | Required | Start date of the query period |
toDate | Date | Required | End date of the query period |
timeZone | String | Optional | Time zone
|
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"
}'
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[].rxBytes | Integer | - | Received data size |
trafficUsageList[].txBytes | Integer | - | Sent data size |
trafficUsageList[].rxBytesIncrement | Integer | - | Increase in data received |
trafficUsageList[].txBytesIncrement | Integer | - | Increase in data sent |
trafficUsageList[].totalIncrement | Integer | - | Total increase in data |
trafficUsageList[].regYmdt | Date | - | Registration Date |
trafficUsageList[].status | String | - | User's status |
trafficUsageList[].memberLastModifyYmdt | Date | - | Last modified date of user information |
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": "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
}
Was this article helpful?