GetFileDetectResult - 获取文件检测结果

更新时间:
复制 MD 格式

通过HashKey批量获取文件检测结果。

接口说明

推送检测过的文件才能获取检测结果,检测结果将保留 5 小时,5 小时内可重复查询。推送检测接口请参考 CreateFileDetect

文件唯一标识

文件检测相关接口均包含 HashKey 参数,表示此次检测文件的唯一标识,用于查询检测结果。仅支持传入文件完整内容的 MD5 或 SHA-256。

查询检测结果

可以通过 Ext 扩展字段里的 FileLabel 对文件属性进行筛选,例如通过组合 encrypted、Zip 这两个属性筛选加密的压缩包。支持的文件标签-压缩文件类型:Zip、RAR、7-Zip、XAR、ZLib、GZip、tar;可以通过 Ext 扩展字段里的 Highlight 字段定位 Webshell 文件的恶意代码段。Highlight 字段为列表类型,列表中每个元素对应一段代码范围,数字表示相对文件头部的偏移字符数。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

SourceIp

string

访问源 IP 地址。

183.46.XX.XX

HashKeyList

array

文件标识列表。最多传入 100 个元素。

string

文件唯一标识。

0a212417e65c26ff133cfff28f9c****

Type

integer

需要检测的文件类型。取值:

  • 0:恶意文件检测

0

返回参数

名称

类型

描述

示例值

object

返回信息。

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

24A20733-10A0-4AF6-BE6B-E3322413BB68

ResultList

array<object>

检测结果列表。

object

文件检测结果信息。

HashKey

string

文件标识。

0a212417e65c26ff133cfff28f6c****

Result

integer

文件检测结果。取值:

  • 0:安全文件

  • 1:可疑文件

  • 3:检测中,请等待

0

Score

integer

文件检测分数。分数区间及危险等级的对应关系如下:

  • 0~60:安全

  • 61~70:风险

  • 71~80:可疑

  • 81~100:恶意

重要 分数越高,文件越可疑。

100

VirusType

string

病毒类型。取值:

  • Trojan:木马程序

  • WebShell:网站后门

  • Backdoor:后门程序

  • RansomWare:勒索病毒

  • Scanner:扫描器

  • Stealer:窃密工具

  • Malbaseware:被污染的基础软件

  • Hacktool:黑客工具

  • Engtest:引擎测试程序

  • Downloader:下载器木马

  • Virus:感染型病毒

  • Miner:挖矿程序

  • Worm:蠕虫病毒

  • DDoS:DDoS 木马

  • Malware:恶意程序

  • RiskWare:风险软件

  • Proxytool:代理工具

  • Suspicious:可疑程序

  • MalScript:恶意脚本

  • Rootkit:Rootkit

  • Exploit:漏洞利用程序

说明

Result 为 0 或 3 时不支持此参数。

WebShell

Code

string

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200

Message

string

错误码的详细信息。

successful

Ext

string

检测结果扩展信息。

{ "HighLight": [ [ 23245, 23212 ] ], "FileLabel": [ "PE32", "Zip", "SFX", "encrypted" ] }

Compress

boolean

是否识别为压缩包。

  • true:是。

  • false:否。

说明

Type 为 6 时不支持此参数。

false

示例

正常返回示例

JSON格式

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "ResultList": [
    {
      "HashKey": "0a212417e65c26ff133cfff28f6c****",
      "Result": 0,
      "Score": 100,
      "VirusType": "WebShell",
      "Code": "200",
      "Message": "successful",
      "Ext": "{\n    \"HighLight\":\n    [\n        [\n            23245,\n            23212\n        ]\n    ],\n    \"FileLabel\":\n    [\n        \"PE32\",\n        \"Zip\",\n        \"SFX\",\n        \"encrypted\"\n    ]\n}",
      "Compress": false
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 RequestTooFrequently Request too frequently, please try again later
400 GetResultFail Get result fail, found no detect record for this file or result has been expired
400 InvalidApiDetectType Unsupported Api Detect Type.
500 ServerError ServerError
500 SystemBusy System busy, please try again later.
403 NoPermission caller has no permission

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情