获取压缩包内文件检测结果列表。
接口说明
推送过检测并且被识别为压缩包的文件才能通过此接口获取文件检测结果列表,检测结果将保留 5 小时,5 小时内可重复查询。推送检测请参考接口 CreateFileDetect。获压缩包文件本身检测结果请参考接口 GetFileDetectResult。
文件检测相关接口均包含 HashKey 参数,表示文件唯一标识,仅支持传入文件完整内容的 MD5 或 SHA-256,请在调用接口前计算该值。注意,一次文件检测的推送和查询接口必须使用同一个 HashKey,否则无法正确推送检测和查询结果。
计算文件内容的 MD5 或 SHA-256 值可以参考以下两个步骤:
-
使用 MD5、SHA-256 算法对数据进行加密,生成 128 位或 256 位的散列值。现有工具库包括 Java 的 MessageDigest 工具、Python 的 hashlib 库等。
-
将生成的散列值编码为十六进制字符串形式,现有工具库包括 Java 的 Codec 工具、Python 的 hex 函数等。请确认最终生成的字符串为数字和小写英文字符的组合,MD5 为 32 个字符,SHA-256 为 64 个字符。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SourceIp | string | 否 | 访问源 IP 地址。 | 27.9.XX.XX |
| HashKey | string | 否 | 文件唯一标识。 | 0a212417e65c26ff133cfff28f6c**** |
| CurrentPage | integer | 是 | 分页查询时,显示的当前页的页码。默认值为 1。 | 1 |
| PageSize | integer | 是 | 分页查询时,显示的每页数据的最大条数。默认值为 20。 | 20 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "E10BAF1C-A6C5-51E2-866C-76D5922E****",
"PageInfo": {
"CurrentPage": 1,
"PageSize": 20,
"TotalCount": 55
},
"ResultList": [
{
"HashKey": "0a212417e65c26ff133cfff28f6c****",
"Result": 0,
"Score": 100,
"VirusType": "WebShell",
"Ext": {
"HighLight": [
[
23245,
23212
]
],
"FileLabel": [
"PE32",
"Zip",
"SFX",
"encrypted"
]
},
"Path": "/root/1.zip/test****"
}
]
}错误码
| 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. | 不支持的文件类型。 |
| 403 | NoPermission | caller has no permission | 当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。 |
| 500 | ServerError | ServerError | 服务故障,请稍后重试! |
| 500 | SystemBusy | System busy, please try again later. | 系统繁忙,请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史
