getTrafficUsage

Classic 환경에서 이용 가능합니다.

Secure Zone Firewall에서 발생한 트래픽 사용량을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/{type}/{zone}/getTrafficUsage

요청 헤더

Secure Zone API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Secure Zone 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`type`	String	Required	Secure Zone에서 제공하는 방화벽 유형 `szfw` \| `psfw` `szfw`: Secure Zone Standard `psfw`: Secure Zone Advanced
`zone`	String	Required	Secure Zone을 구성한 존 `kr1` \| `kr2` `kr1`: KR-1 존 `kr2`: KR-2 존

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`status`	String	Optional	사용자의 상태 `USE` \| `END`
`page`	Integer	Optional	페이지 인덱스 0 (기본값)
`countPerPage`	Integer	Optional	페이지당 항목 수 0 (기본값)
`fromDate`	Date	Required	조회 기간의 시작일
`toDate`	Date	Required	조회 기간의 종료일
`timeZone`	String	Optional	타임 존 +09:00 (기본값)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://securezonefirewall.apigw.gov-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"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`action`	String	-	요청 유형
`returnCode`	Integer	-	응답 코드
`returnMessage`	String	-	응답 메시지
`trafficUsageList[]`	Array	-	트래픽 사용량 데이터 목록
`trafficUsageList[].memberNo`	String	-	사용자의 네이버 클라우드 플랫폼 회원 번호
`trafficUsageList[].instanceNo`	String	-	인스턴스 생성 시 부여된 계약 번호
`trafficUsageList[].secureZoneName`	String	-	Secure Zone 이름
`trafficUsageList[].checkDate`	String	-	점검일(yyyy-MM-dd)
`trafficUsageList[].checkTime`	String	-	점검 시점(hh:mm:ss)
`trafficUsageList[].checkHour`	String	-	점검 시(hh)
`trafficUsageList[].rxBytes`	Integer	-	수신한 데이터 용량
`trafficUsageList[].txBytes`	Integer	-	송신한 데이터 용량
`trafficUsageList[].rxBytesIncrement`	Integer	-	수신 데이터의 증가량
`trafficUsageList[].txBytesIncrement`	Integer	-	송신 데이터의 증가량
`trafficUsageList[].totalIncrement`	Integer	-	총 데이터의 증가량
`trafficUsageList[].regYmdt`	Date	-	등록일
`trafficUsageList[].status`	String	-	사용자의 상태
`trafficUsageList[].memberLastModifyYmdt`	Date	-	사용자 정보 최종 수정일
`totalCount`	Integer	-	트래픽 사용량 데이터 개수

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "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
}