該接口用于主動查詢指定的異步任務信息。IMM支持多種異步數據處理能力,每種能力有各自創(chuàng)建任務的接口,例如創(chuàng)建人物人臉聚類任務CreateFigureClusteringTask、創(chuàng)建文件壓縮任務CreateFileCompressionTask等。本接口為通用接口,可以通過任務ID和類型來查詢異步任務的詳細信息。
接口說明
請確保在使用該接口前,已充分了解智能媒體管理產品的收費方式和價格。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
imm:GetTask | get | *Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectName | string | 是 | 項目名稱,獲取方式請參見創(chuàng)建項目。 | immtest |
TaskType | string | 是 | 任務的類型。取值范圍請參見任務類型列表。 | FileCompression |
TaskId | string | 是 | 需要查詢的任務 ID,該值在創(chuàng)建任務時作為返回參數。 | FileCompression-2f157087-91df-4fda-8c3e-232407ec***** |
RequestDefinition | boolean | 否 | 是否需要返回創(chuàng)建任務的初始請求參數,默認值為 False。 | True |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "2C5C1E0F-D8B8-4DA0-8127-EC32C771****",
"ProjectName": "test-project",
"EventId": "2F6-1Bz99Xi93EnRpNEyLudILJm****",
"Status": "Running",
"Code": "ResourceNotFound",
"Message": "The specified resource project is not found.",
"StartTime": "2021-12-24T03:01:41.662060377Z",
"EndTime": "2021-12-24T03:01:49.480109219Z",
"UserData": "{\"ID\": \"user1\",\"Name\": \"test-user1\",\"Avatar\": \"http://example.com?id=user1\"}",
"TaskType": "FileCompression",
"TaskId": "c2b277b9-0d30-4882-ad6d-ad661382****",
"Tags": {
"test": "val1"
},
"TaskRequestDefinition": "{\n\t\"ProjectName\":\"test-project\",\n\t\"CompressedFormat\":\"zip\",\n\t\"TargetURI\":\"oss://test-bucket/output/test.zip\",\n\t\"Sources\":[{\"URI\":\"oss://test-bucket/input/test.jpg\"}]\n}",
"Progress": 100
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-05-11 | OpenAPI 入參發(fā)生變更、OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |