文档

GetFileDetectResult - 获取文件检测结果

更新时间:

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

接口说明

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

文件检测相关接口均包含 HashKey 参数,表示文件唯一标识,目前仅支持文件完整内容的十六进制 md5 值,请在使用接口前计算该值。

可以通过 Ext 扩展字段里的 FileLabel 对文件属性进行筛选,例如通过组合 encrypted、Zip 这两个属性筛选加密的压缩包。支持的文件标签-压缩文件类型:Zip、RAR、7-Zip、XAR、ZLib、GZip、tar。

可以通过 Ext 扩展字段里的 Highlight 字段定位 Webshell 文件的恶意代码段。Highlight 字段为列表类型,列表中每个元素对应一段代码范围,数字表示相对文件头部的偏移字符数。

计算文件内容的十六进制 md5 值可以参考以下两个步骤:

1.使用 MD5 算法对数据进行加密,生成 128 位的散列值。现有工具库包括 Java 的 MessageDigest 工具、Python 的 hashlib 库等。

2.将生成的散列值转换为 16 进制字符串形式。现有工具库包括 Java 的 Codec 工具、Python 的 hex 函数等。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:GetFileDetectResultRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SourceIpstring

访问源 IP 地址。

183.46.XX.XX
HashKeyListarray

文件标识列表,目前仅支持 md5。列表最多传入 100 个元素。

string

文件标识,目前仅支持 md5。

0a212417e65c26ff133cfff28f9c****
Typeinteger

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

  • 0:不确定的文件类型
  • 1:二进制文件
  • 2:WebShell 文件
  • 4:脚本文件
说明 如果不确定文件类型,将该参数的值设置为 0。
0

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

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

24A20733-10A0-4AF6-BE6B-E3322413BB68
ResultListobject []

检测结果列表。

HashKeystring

文件标识,仅支持文件 md5。

0a212417e65c26ff133cfff28f6c****
Resultinteger

文件检测结果。取值:

  • 0:安全文件
  • 1:可疑文件
  • 3:检测中,请等待
0
Scoreinteger

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

  • 0~60:安全
  • 61~70:风险
  • 71~80:可疑
  • 81~100:恶意

注意 分数越高,文件越可疑。

100
VirusTypestring

病毒类型。取值:

  • Trojan:自变异木马
  • WebShell:网站后门
  • Backdoor:后门程序
  • RansomWare:勒索病毒
  • Scanner:扫描器
  • Stealer:窃密工具
  • Malbaseware:被污染的基础软件
  • Hacktool:黑客工具
  • Engtest:引擎测试程序
  • Downloader:下载器木马
  • Virus:感染型病毒
  • Miner:挖矿程序
  • Worm:蠕虫病毒
  • DDoS:DDOS 木马
  • Malware:恶意程序
  • Backdoor:反弹 shell 后门
  • RiskWare:风险软件
  • Proxytool:代理工具
  • Suspicious:可疑程序
  • MalScript:恶意脚本
  • Rootkit:Rootkit
  • Exploit:漏洞利用程序
WebShell
Codestring

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

200
Messagestring

错误码的详细信息。

successful
Extstring

检测结果扩展信息。

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

示例

正常返回示例

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}"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400RequestTooFrequentlyRequest too frequently, please try again later请求太频繁,请稍后再试
400GetResultFailGet result fail, found no detect record for this file or result has been expired获取结果失败,未找到文件推送记录或者检测结果已过期。
400InvalidApiDetectTypeUnsupported Api Detect Type.不支持的文件类型。
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!
500SystemBusySystem busy, please try again later.系统繁忙,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2023-06-19OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
  • 本页导读 (1)
文档反馈