文件推送到云端检测。
接口说明
通过此接口将文件推送到云端检测，调用前请确认文件已成功上传，文件上传的方式参考 CreateFileDetectUploadUrl 接口。
文件检测相关接口均包含 HashKey 参数，表示文件唯一标识，目前仅支持文件完整内容的十六进制 md5 值，请在使用接口前计算该值。
计算文件内容的十六进制 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:CreateFileDetect | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SourceIp | string | 否 | 访问源的 IP 地址。 | 115.213.XX.XX |
| Type | integer | 是 | 需要检测的文件类型。取值：
| 0 |
| HashKey | string | 是 | 文件标识，仅支持文件 md5。 | 0a212417e65c26ff133cfff28f6c**** |
| OssKey | string | 否 | 文件在 OSS Bucket 中的存储 key。如果通过 DownloadUrl 推送文件检测，此参数可不填。此参数通过 CreateFileDetectUploadUrl 接口获取。 | 1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8**** |
| DownloadUrl | string | 否 | 文件下载链接。支持传入文件下载链接（公网 URL）直接触发文件检测，不需要提前上传文件。 | https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx |
| Decompress | boolean | 否 | 是否识别压缩包并解压。取值：
| false |
| DecompressMaxLayer | integer | 否 | 当压缩包内，存在多个层级的压缩包嵌套时，解压的最大解压层数。最大取值为 5。 Decompress 设置为 true 时，此参数不可为空。 | 1 |
| DecompressMaxFileCount | integer | 否 | 解压的最大文件数。最大取值为 1000。 Decompress 设置为 true 时，此参数不可为空。 | 100 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
"HashKey": "0a212417e65c26ff133cfff28f6c****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | RequestTooFrequently | Request too frequently, please try again later | 请求太频繁，请稍后再试 |
| 400 | GetFileError | Get file error, please check input params and file size, and make sure upload file success. | 获取文件失败，请依次检查输入参数无误且文件大小未超出限制，并确认文件已上传成功。 |
| 400 | InvalidDownloadUrl | Invalid file download URL. | 无效的文件下载链接。 |
| 400 | FileSizeOverLimit | File size over limit. | 文件大小超出限制。 |
| 403 | NoPermission | caller has no permission | 当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。 |
| 500 | ServerError | ServerError | 服务故障，请稍后重试！ |
| 500 | SystemBusy | System busy, please try again later. | 系统繁忙，请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-04-16 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-05-11 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-05-11 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |