getThresholdNotiConfig

Prev Next

Classic/VPC環境で利用できます。

File Filterを使用した分析結果の通知設定で高度な設定値を照会します。高度な設定は、一定時間、しきい値に該当するマルウェアが検出されると通知する機能です。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /getThresholdNotiConfig

リクエストヘッダ

File Safer APIで共通して使用されるヘッダの詳細は、File Safer APIの共通ヘッダをご参照ください。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://filesafer.apigw.ntruss.com/filefilter/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 Required レスポンスコード
returnMessage String Required レスポンスメッセージ
thresholdNotificationInfoList[] Array Required 分析結果の通知設定情報
  • オブジェクトがある場合: 通知設定
  • オブジェクトがない場合: 通知設定をしない
thresholdNotificationInfoList[].notificationType String Conditional 分析結果の通知条件
  • MAL | ERR
    • MAL: マルウェア検出時に通知
    • ERR: 照会失敗時に通知
  • 通知設定内で高度な設定をした場合にのみ含む
thresholdNotificationInfoList[].referenceTime Integer Conditional しきい値に該当するマルウェアを検出する時間(分)
  • 5~30
  • 通知設定内で高度な設定をした場合にのみ含む
thresholdNotificationInfoList[].thresholdValue Integer Conditional しきい値(件)
  • 1~1000
  • 通知設定内で高度な設定をした場合にのみ含む

レスポンスステータスコード

File Safer APIで共通して使用されるレスポンスステータスコードの詳細は、File Saferのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

高度な設定をした場合

分析結果の通知設定で高度な設定をした場合、レスポンスのサンプルコードは次の通りです。

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

高度な設定をしなかった場合

分析結果の通知設定で高度な設定をしなかった場合、レスポンスのサンプルコードは次の通りです。

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