檔案推送到雲端檢測。
介面說明
通過此介面將檔案推送到雲端檢測,支援惡意檔案檢測和 Skill 壓縮包檢測兩種情境。
檔案上傳方式
檔案上傳方式支援預先上傳和下載連結。
如果使用預先上傳的方式,調用前請確認檔案已成功上傳,檔案上傳方式參考 CreateFileDetectUploadUrl 介面。
如果使用下載連結的方式,請通過 DownloadUrl 參數傳入可通過公網訪問的下載連結。
惡意檔案檢測情境支援以上兩種方式。Skill 壓縮包檢測情境(Type 為 6)暫不支援預先上傳方式,只能傳入下載連結。
檔案唯一標識
檔案檢測相關介面均包含 HashKey 參數,表示此次檢測檔案的唯一標識,用於查詢檢測結果。
Skill 壓縮包檢測情境(Type 為 6)不需要提前計算 HashKey,本介面將會返回全域唯一的 UUID 作為檔案標識,後續通過該標識查詢結果。
惡意檔案檢測情境(Type 為 0)需要在調用介面前提前計算 HashKey,且僅支援傳入檔案完整內容的 MD5 或 SHA-256。
計算檔案內容的 MD5 或 SHA-256 值可以參考以下兩個步驟:
-
使用 MD5、SHA-256 演算法對資料進行加密,產生 128 位或 256 位的散列值。現有工具庫包括 Java 的 MessageDigest 工具、Python 的 hashlib 庫等。
-
將產生的散列值編碼為十六進位字串形式,現有工具庫包括 Java 的 Codec 工具、Python 的 hex 函數等。請確認最終產生的字串為數字和小寫英文字元的組合,MD5 為 32 個字元,SHA-256 為 64 個字元。
注意,單次檢測的推送和查詢介面必須使用同一個 HashKey,否則無法正確推送檢測和查詢結果。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-sas:CreateFileDetect |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| SourceIp |
string |
否 |
訪問源的 IP 位址。 |
115.213.XX.XX |
| Type |
integer |
是 |
需要檢測的檔案類型。取值:
|
0 |
| HashKey |
string |
否 |
檔案唯一標識。 Type 為 0 時此參數必填,且必須為檔案的 MD5 或 SHA-256。 Type 為 6 時此參數不用填,檔案唯一標識通過介面傳回值擷取。 |
0a212417e65c26ff133cfff28f6c**** |
| OssKey |
string |
否 |
檔案在 OSS Bucket 中的儲存 key。 如果通過 DownloadUrl 推送檔案檢測,此參數可不填。此參數通過 CreateFileDetectUploadUrl 介面擷取。 說明
Type 為 6 時不支援此參數。 |
1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8**** |
| DownloadUrl |
string |
否 |
檔案下載連結。支援傳入檔案下載連結(公網 URL)直接觸發檔案檢測,不需要提前上傳檔案。 說明
Skill 壓縮包目前只支援通過 URL 傳入檔案,所以 Type 為 6 時此參數必填。 |
https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx |
| Decompress |
boolean |
否 |
是否識別壓縮包並解壓。取值:
說明
Type 為 6 時不支援此參數。 |
false |
| DecompressMaxLayer |
integer |
否 |
當壓縮包內,存在多個層級的壓縮包嵌套時,解壓的最大解壓層數。最大取值為 5。 Decompress 設定為 true 時,此參數不可為空白。 說明
Type 為 6 時不支援此參數。 |
1 |
| DecompressMaxFileCount |
integer |
否 |
解壓的最大檔案數。最大取值為 1000。 Decompress 設定為 true 時,此參數不可為空白。 說明
Type 為 6 時不支援此參數。 |
100 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
本次調用請求的 ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。 |
7E0618A9-D5EF-4220-9471-C42B5E92719F |
| HashKey |
string |
檔案標識。 |
0a212417e65c26ff133cfff28f6c**** |
樣本
正常返回樣本
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. | 檔案大小超出限制。 |
| 500 | ServerError | ServerError | 服務故障,請稍後重試! |
| 500 | SystemBusy | System busy, please try again later. | 系統繁忙,請稍後重試。 |
| 403 | NoPermission | caller has no permission | 當前操作未被授權,請聯絡主帳號在RAM控制台進行授權後再執行操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。