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は、Naverクラウドプラットフォームで使う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 | Naverクラウドプラットフォームから発行された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 : すべて通知します。 |
レスポンス
レスポンスボディ (Hash Filter, File Filter)
| フィールド名 | 必須 | タイプ | 説明 |
|---|---|---|---|
| returnCode | Yes | string | リクエストに対する処理結果コードです。 |
| returnMessage | Yes | string | リクエストに対する処理結果メッセージです。 |
例示
Hash Filter リクエスト例示
curl -X GET "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 GET "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"
}
この記事は役に立ちましたか?