全部產品
Search

搜尋本產品

    ：GetTask - 擷取任務資訊

    文件中心

    ：GetTask - 擷取任務資訊

    更新時間：Feb 26, 2026

    該介面用於主動查詢指定的非同步任務資訊。IMM支援多種非同步資料處理能力，每種能力有各自建立任務的介面，例如建立人物人臉聚類任務CreateFigureClusteringTask、建立檔案壓縮任務CreateFileCompressionTask等。本介面為通用介面，可以通過任務ID和類型來查詢非同步任務的詳細資料。

    介面說明

    請確保在使用該介面前，已充分瞭解Intelligent Media Management產品的收費方式和價格。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    imm:GetTask

    get

    *Project

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ProjectName

    string

    是

    專案名稱，擷取方式請參見建立專案。

    immtest
    TaskType

    string

    是

    任務的類型。取值範圍請參見任務類型列表。

    FileCompression
    TaskId

    string

    是

    需要查詢的任務 ID，該值在建立任務時作為返回參數。

    FileCompression-2f157087-91df-4fda-8c3e-232407ec*****
    RequestDefinition

    boolean

    否

    是否返回建立任務的原始請求參數，取值如下：

    • true。

    • false(預設值)。

    當前該參數僅對部分任務類型生效，支援的任務類型如下：

    • MediaConvert

    • VideoLabelClassification

    • FaceClustering

    • FileCompression

    • ArchiveFileInspection

    • FileUncompression

    • PointCloudCompress

    • ImageToPDF

    • StoryCreation

    • LocationDateClustering

    • ImageSplicing

    • FacesSearching

    true

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    查詢到指定任務的詳細資料。

    RequestId

    string

    請求 ID。

    2C5C1E0F-D8B8-4DA0-8127-EC32C771****
    ProjectName

    string

    專案名稱。

    test-project
    EventId

    string

    事件 ID。

    2F6-1Bz99Xi93EnRpNEyLudILJm****
    Status

    string

    任務運行狀態。取值範圍如下：

    • Running：任務運行中。

    • Succeeded：任務執行完成，成功。

    • Failed：任務執行完成，失敗。

    Running
    Code

    string

    任務錯誤碼。

    ResourceNotFound
    Message

    string

    任務錯誤訊息。

    The specified resource project is not found.
    StartTime

    string

    任務開始時間。

    2021-12-24T03:01:41.662060377Z
    EndTime

    string

    任務結束時間。

    2021-12-24T03:01:49.480109219Z
    UserData

    string

    使用者自訂資訊。

    {"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
    TaskType

    string

    任務的類型。取值範圍請參見任務類型列表。

    FileCompression
    TaskId

    string

    任務 ID。

    c2b277b9-0d30-4882-ad6d-ad661382****
    Tags

    object

    任務標籤。使用者在建立任務時傳入的“Tag”標籤。

    {"test": "val1"}
    TaskRequestDefinition

    string

    建立任務的初始請求參數。

    { "ProjectName":"test-project", "CompressedFormat":"zip", "TargetURI":"oss://test-bucket/output/test.zip", "Sources":[{"URI":"oss://test-bucket/input/test.jpg"}] }
    Progress

    integer

    任務進度。取值範圍為 0~100，單位為百分比（%）。

    說明

    • 目前 GetTask 介面暫不支援該參數。

    • 該參數僅在任務運行狀態State為Running時有意義。

    100

    樣本

    正常返回樣本

    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
}

    錯誤碼

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

    變更歷史

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