全部产品
Search

搜索本产品

    云安全中心：GetFileDetectResult - 获取文件检测结果

    文档中心

    云安全中心：GetFileDetectResult - 获取文件检测结果

    更新时间：Nov 14, 2024

    通过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暂无授权信息透出。

    请求参数

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

    访问源 IP 地址。

    		183.46.XX.XX
    HashKeyListarray是

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

    string是

    文件标识，目前仅支持 MD5。

    		0a212417e65c26ff133cfff28f9c****
    Typeinteger是

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

    • 0：不确定的文件类型
    		0

    返回参数

    名称类型描述示例值
    object

    返回信息。

    RequestIdstring

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

    		24A20733-10A0-4AF6-BE6B-E3322413BB68
    ResultListarray<object>

    检测结果列表。

    Resultobject

    文件检测结果信息。

    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：恶意程序
    • RiskWare：风险软件
    • Proxytool：代理工具
    • Suspicious：可疑程序
    • MalScript：恶意脚本
    • Rootkit：Rootkit
    • Exploit：漏洞利用程序
    		WebShell
    Codestring

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

    		200
    Messagestring

    错误码的详细信息。

    		successful
    Extstring

    检测结果扩展信息。

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

    是否识别为压缩包。

    • true：是。

    • false：否。

    		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错误码错误信息描述
    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.系统繁忙，请稍后重试。

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

    变更历史

    变更时间变更内容概要操作
    2024-04-16OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-06-19OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情