getThresholdNotiConfig

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

Hash Filter를 사용한 분석 결과의 통보 설정에서 고급 설정 값을 조회합니다. 고급 설정은 일정 시간 동안 임계치에 해당하는 악성코드가 탐지되면 통보하는 기능입니다.

요청

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

메서드	URI
POST	/hashfilter/v1/getThresholdNotiConfig

요청 헤더

File Safer API에서 공통으로 사용하는 헤더에 대한 정보는 File Safer 요청 헤더를 참조해 주십시오.

요청 예시

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

curl --location --request POST 'https://filesafer.apigw.gov-ntruss.com/hashfilter/v1/getThresholdNotiConfig' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-api-key: {API Gateway API Key}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`returnCode`	String	-	응답 코드
`returnMessage`	String	-	응답 메시지
`thresholdNotificationInfoList`	Array	-	분석 결과의 통보 설정 정보: thresholdNotificationInfoList 객체가 있는 경우: 통보 설정 객체가 없는 경우: 통보 설정 안 함

`thresholdNotificationInfoList`

thresholdNotificationInfoList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`notificationType`	String	-	분석 결과 통보 조건 `MAL` \| `ERR` `MAL`: 악성 코드 탐지 시 통보 `ERR`: 조회 실패 시 통보 통보 설정 내 고급 설정을 한 경우에만 포함
`referenceTime`	Integer	-	임계치에 해당하는 악성코드를 탐지하는 시간(분) 5~30 통보 설정 내 고급 설정을 한 경우에만 포함
`thresholdValue`	Integer	-	임계치(건) 1~1000 통보 설정 내 고급 설정을 한 경우에만 포함

응답 상태 코드

File Safer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 File Safer 응답 상태 코드를 참조해 주십시오.

응답 예시

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

고급 설정을 한 경우

분석 결과의 통보 설정에서 고급 설정을 한 경우의 응답 예시는 다음과 같습니다.

{
    "returnCode": "0",
    "returnMessage": "success",
    "thresholdNotificationInfoList": [
        {
            "notificationType": "MAL",
            "referenceTime": 5,
            "thresholdValue": 1
        }
    ]
}

고급 설정을 하지 않은 경우

분석 결과의 통보 설정에서 고급 설정을 하지 않은 경우의 응답 예시는 다음과 같습니다.

{
    "returnCode": "0",
    "returnMessage": "success",
    "thresholdNotificationInfoList": [
    ]
}