CreateArchiveFileInspectionTask - 建立壓縮包預覽解析任務 -

介面說明

說明

介面公測中，如有任何使用問題，請加入DingTalk群進行反饋，DingTalk群號請參見聯絡我們。

請確保在使用該介面前，已充分瞭解Intelligent Media Management產品的收費方式和價格。
重要非同步任務不保證時效。
檔案數量限制：最多支援包含 8 萬個檔案的壓縮包。
檔案大小限制：zip 和 rar 格式最多支援 200 GB，7z 格式最多支援 50 GB。
該介面為非同步介面，擷取任務開始執行後，任務資訊只儲存 7 天，超過 7 天則無法再擷取。調用 GetTask 或 ListTasks 介面擷取返回的TaskId，查看任務資訊。也可以通過設定 Notification 訊息通知參數，通過訊息通知擷取任務資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

imm:CreateArchiveFileInspectionTask

create

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectName	string	是	專案名稱，擷取方式請參見建立專案。	test-project
CredentialConfig	CredentialConfig	否	如無特殊需求，請保持留空即可。鏈式授權配置，非必填。更多資訊，請參見使用鏈式授權訪問其他實體資源。
Password	string	否	檔案壓縮密碼。檔案壓縮時如果加密壓縮時，查看壓縮包內資訊需要提供壓縮密碼。	123456
UserData	string	否	使用者自訂資訊，在非同步訊息通知中會為您返回，方便您系統內對訊息通知進行關聯處理。最大長度為 2048 位元組。	test-data
SourceURI	string	否	壓縮檔存放的位置。 OSS 地址規則為 oss://${Bucket}/${Object}，其中`${Bucket}`為和當前專案處於同一地區(Region)的 OSS Bucket 名稱，`${Object}`為包含副檔名的檔案完整路徑。	oss://bucket/test-object.zip
Notification	Notification	否	訊息通知配置，詳細內容請單擊 Notification 查看，非同步通知訊息格式請參見非同步通知訊息格式。說明 Intelligent Media Management目前介面調用回調不支援指定回調地址，建議您使用 MNS。

建立壓縮包預覽解析任務請設定Notification中的ExtendedMessageURI參數，用於擷取壓縮包內檔案清單資訊。產生的打包檔案清單資訊如下所示：

{
  "Password" : "壓縮包的密碼",
  "IsEncryption": "true/false, 壓縮包是否加密",
  "ArchiveFiles": [
    {
      "PathName": "檔案相對於壓縮包的路徑，例如./test-dir/test.txt",
      "Reason": "如果預覽失敗，該檔案預覽失敗的原因",
      "IsFolder": "true/false，該檔案是否是檔案夾",
      "PackedSize": "壓縮包內檔案大小",
      "UnPackedSize": "解壓後檔案大小",
      "FileAccessTime": "檔案時間資訊",
    },
    {
      "PathName": "./test-dir/",
      "Reason": "",
      "IsFolder": "true",
      "PackedSize": "0",
      "UnPackedSize": "0",
      "FileAccessTime": "2023-07-21T09:46:35Z",
    },
  ]
}

返回參數

名稱	類型	描述	樣本值
	object	響應結構體
RequestId	string	請求 ID。	EC564A9A-BA5C-4499-A087-D9B9E76E*****
EventId	string	事件 ID。	0ED-1Bz8z71k5TtsUejT4UJ16Es*****
TaskId	string	任務 ID。	ArchiveFileInspection-8475218e-d86e-4c66-b3cf-50e74d6c****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es*****",
  "TaskId": "ArchiveFileInspection-8475218e-d86e-4c66-b3cf-50e74d6c****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。