setNotiConfig (Hash Filter, File Filter)
- 인쇄
- PDF
setNotiConfig (Hash Filter, File Filter)
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
개요
- setNotiConfig API 는 "File Safer"의 "Hash Filter"에서 제공하는 기능으로 분석 결과 통보 설정을 할 수 있는 API입니다.
- 해당 API는 네이버 클라우드 플랫폼에서 사용하는 IAM인증 및 API Gateway를 통해 사용하실 수 있습니다.
Hash Filter 요청
| Method | Request URI |
|---|---|
| POST | https://filesafer.apigw.ntruss.com/hashfilter/v1/setNotiConfig |
File Filter 요청
| Method | Request URI |
|---|---|
| POST | https://filesafer.apigw.ntruss.com/filefilter/v1/setNotiConfig |
요청 헤더
| 헤더명 | 설명 |
|---|---|
| x-ncp-apigw-timestamp | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
| x-ncp-apigw-api-key | API Gateway에서 발급받은 키 |
| x-ncp-iam-access-key | 네이버 클라우드 플랫폼에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKey |
| x-ncp-apigw-signature-v2 | 요청 경로 및 헤더를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명으로 HMAC 암호화 알고리즘은 HmacSHA256 사용 IAM 인증이 필요한 API 호출하기를 참조 |
| accept | json을 명시application/json |
요청 파라미터
요청 바디
{
"notificationType": "type"
}
| 파라미터명 | 필수 여부 | 타입 | 설명 |
|---|---|---|---|
| notificationType | Yes | string | - 분석 결과 통보 설정 값 'OFF, MAL, MAE, ERR, ALL' 중 하나의 값을 가질 수 있음 OFF : 통보하지 않음 MAL : 악성코드 탐지 시 통보 MAE : 악성코드 탐지 또는 조회 실패 시 통보 ERR : 조회 실패 시 통보 ALL : 모두 통보 |
응답
응답 바디
| 필드명 | 필수 여부 | 타입 | 설명 |
|---|---|---|---|
| returnCode | Yes | string | 요청에 대한 처리 결과 코드 |
| returnMessage | Yes | string | 요청에 대한 처리 결과 메시지 |
예시
Hash Filter요청 예시
curl -X POST "https://filesafer.apigw.ntruss.com/hashfilter/v1/setNotiConfig"
-H "accept: application/json"
-H "x-ncp-apigw-api-key: {x-ncp-apigw-api-key}"
-H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
-H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
-H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
-d {"notificationType":{notificationType}}
File Filter요청 예시
curl -X POST "https://filesafer.apigw.ntruss.com/filefilter/v1/setNotiConfig"
-H "accept: application/json"
-H "x-ncp-apigw-api-key: {x-ncp-apigw-api-key}"
-H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
-H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
-H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
-d {"notificationType":{notificationType}}
응답 예시 (결과 통보 설정 성공 시)
{
"returnCode": "0",
"returnMessage": "success"
}
이 문서가 도움이 되었습니까?