GetFileDetectResult_云安全中心_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

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

文件检测相关接口均包含 HashKey 参数,表示文件唯一标识,仅支持传入文件完整内容的 MD5 或 SHA-256,请在调用接口前计算该值。注意,一次文件检测的推送和查询接口必须使用同一个 HashKey,否则无法正确推送检测和查询结果。

计算文件内容的 MD5 或 SHA-256 值可以参考以下两个步骤:

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

  2. 将生成的散列值编码为十六进制字符串形式,现有工具库包括 Java 的 Codec 工具、Python 的 hex 函数等。请确认最终生成的字符串为数字和小写英文字符的组合,MD5 为 32 个字符,SHA-256 为 64 个字符。

流控信息

请求速率为1000/1(s)。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
SourceIpstring

访问源 IP 地址。

示例值:183.46.XX.XX参考取值来源:
    DescribeDataSource
HashKeyListarray<string>

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

子级条数 <= 200
Typeinteger<int32>

需要检测的文件类型。取值:展开详情

示例值:0

返回参数

字段名称字段详情
RequestIdstring

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

示例值:24A20733-10A0-4AF6-BE6B-E3322413BB68
ResultListarray<object>

检测结果列表。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断
403
NoPermission
caller has no permission诊断
500
ServerError
ServerError诊断
500
SystemBusy
System busy, please try again later.诊断

变更历史

变更时间变更内容概要操作
2024-04-16
变更返回参数
2023-06-19
变更请求参数HashKeyList
删除返回参数
2022-08-16
变更返回参数
2022-07-26
变更返回参数
2022-07-20
变更错误码400
变更返回参数
2022-06-27
变更返回参数
2022-06-23
变更返回参数

相关示例

2024年08月20日