getInputFileLog

Prev Next

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

inputFile APIを通じて転送したファイルを File Filterで分析した結果を照会します。

リクエスト

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

メソッド URI
GET /getInputFileLog

リクエストヘッダ

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

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
hash String Required 照会対象の Hash
hashType String Required 照会対象の Hashの作成に使用したアルゴリズム
  • sha1 | md5

リクエスト例

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

curl --location --request GET 'https://filesafer.apigw.ntruss.com/filefilter/v1/getInputFileLog
?hash=f093e7767bb63ac973b697d3fd1d40a78b87b8bf
&hashType=sha1' \
--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 - レスポンスメッセージ
inputFileLogList[] Array - 分析リクエストされたファイルの分析結果
  • 同じ Hashのファイルを2回以上分析した場合はリストで表示
  • 分析したファイルがない場合は空状態にする
inputFileLogList[].fileType String - 分析したファイルの形式
  • 分析したファイルがある場合にのみ含む
inputFileLogList[].fileSize Integer - 分析したファイルのサイズ
  • 分析したファイルがある場合にのみ含む
inputFileLogList[].parentSha1 String - 分析リクエストした圧縮ファイルの SHA1 Hash
  • 分析したファイルがある場合にのみ含む
inputFileLogList[].md5 String - 分析したファイルの MD5 Hash
  • 分析したファイルがある場合にのみ含む
inputFileLogList[].sha1 String - 分析したファイルの SHA1 Hash
  • 分析したファイルがある場合にのみ含む
inputFileLogList[].sha256 String - 分析したファイルの SHA256 Hash
  • 分析したファイルがある場合にのみ含む
inputFileLogList[].analysisStatusCode String - 分析状態コード
  • IPRG | CMPL | ERR | EXCN
    • IPRG: 分析中(Analyzing)
    • CMPL: 分析完了(Analysis Completed)
    • ERR: 分析エラー(Analysis Error)
    • EXCN: 分析例外(Exclude Analysis)
  • 分析したファイルがある場合にのみ含む
inputFileLogList[].analysisResultCode String - 分析結果コード
  • M | N | E
    • M: マルウェア(Malware Detected)
    • N: 正常(Malware not Detected)
    • E: エラー(Detection Error)
  • 分析したファイルがある場合にのみ含む
inputFileLogList[].notifyYmdt Long - 通知を設定した場合、通知の送信時間
  • 分析したファイルがある場合にのみ含む
inputFileLogList[].registrationYmdt Long - ファイル流入時間
  • 分析したファイルがある場合にのみ含む
参考

serviceCodeapplicationCodeはレスポンス結果に表示される場合がありますが、ユーザーが参照すべきフィールドではありません。

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

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

レスポンス例

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

分析したファイルがある場合

分析したファイルがある場合、レスポンスのサンプルコードは次の通りです。

{
    "returnCode": "0",
    "returnMessage": "success",
    "inputFileLogList": [
        {
            "fileType": "Adobe Portable Document Format",
            "fileSize": 68584,
            "parentSha1": "4fa122a164fab49701d440dc376a108b2ab71bc4",
            "md5": "83861ed7105eb8b9886616f9f0428b62",
            "sha1": "ea445bec4e8f79c5a2f8db5a368f2c3c741e238f",
            "sha256": "ff8ca1b607ab03268078d9bde33980e16ca45aa3c798e2b963ca89efd87714cc",
            "analysisStatusCode": "CMPL",
            "analysisResultCode": "N",
            "notifyYmdt": null,
            "registrationYmdt": 1697766000000,
            "serviceCode": null,
            "applicationCode": null
        },
        {
            "fileType": "Adobe Portable Document Format",
            "fileSize": 56686,
            "parentSha1": "4fa122a164fab49701d440dc376a108b2ab71bc4",
            "md5": "e162e32656ff4b4666d14bc43f9238c1",
            "sha1": "d4021b08bcaa08255afd1b80bf9c39ab46116447",
            "sha256": "40aa534c3cd62f4d7585a9bbf06a4af23b771d8b39127f16b2ec2503bffcd4aa",
            "analysisStatusCode": "CMPL",
            "analysisResultCode": "N",
            "notifyYmdt": null,
            "registrationYmdt": 1697766000000,
            "serviceCode": null,
            "applicationCode": null
        }
    ]
}

分析したファイルがない場合

分析したファイルがない場合、レスポンスのサンプルコードは次の通りです。

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