全部產品
Search
文件中心

:ListTasks - 查詢工作清單

更新時間:Feb 26, 2026

該介面提供通過多種條件查詢工作清單的功能。通過該介面可以查詢指定時間範圍內的任務、或者通過建立任務時指定的Tag搜尋任務等。

介面說明

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

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

imm:ListTasks

list

*Project

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

請求參數

名稱

類型

必填

描述

樣本值

ProjectName

string

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

test-project

TaskTypes

array

查詢的任務類型列表。

string

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

["OfficeConversion","VideoLabelClassification"]

NextToken

string

翻頁標記。

當檔案總數大於設定的 MaxResults 時,用於翻頁的 Token。從 NextToken 開始按字典序返迴文件資訊列表。

說明

在一次查詢中首次調用此介面時,將此值設定為空白。

MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==

MaxResults

integer

返回結果清單中最大任務數量。取值範圍為(0,100 ],預設值為 100。

1

TagSelector

string

自訂任務標籤。在建立任務時如果指定了“Tag”參數,可以通過此參數進行搜尋。

test=val1

Sort

string

返回的任務資訊列表定序。取值範圍如下:

  • TaskId(預設):任務 ID。

  • StartTime:任務開始時間。

  • EndTime:任務結束時間。

TaskId

Order

string

排序方式。取值範圍如下:

  • asc(預設):升序

  • desc:降序

枚舉值:

  • asc :

    升序

  • desc :

    降序

asc

Status

string

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

  • Running:任務運行中。

  • Succeeded:任務執行完成,成功。

  • Failed:任務執行完成,失敗。

枚舉值:

  • Succeeded :

    任務執行完成,成功

  • Failed :

    任務執行完成,失敗

  • Running :

    任務運行中

Succeeded

StartTimeRange TimeRange

任務開始的時間範圍。可篩選某段時間內開始執行的任務。

EndTimeRange TimeRange

任務結束的時間範圍。可篩選某段時間內結束執行的任務。

RequestDefinition

boolean

是否需要返回建立任務的初始請求參數,預設值為 False。

True

返回參數

名稱

類型

描述

樣本值

object

合格工作清單。

RequestId

string

請求 ID。

9847E7D0-A9A3-0053-84C6-BA16FFFA726E

ProjectName

string

專案名稱。

immtest

NextToken

string

翻頁標記。當工作清單總數大於設定的 MaxResults 時,用於翻頁的 Token。合格工作清單未全部返回時,此參數才有值。

下一次列出工作清單時將此值作為 NextToken 傳入,將後續的工作清單返回。

MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==

MaxResults

string

本次返回的工作清單長度。

1

Tasks

array

任務資訊列表。

TaskInfo

任務的詳細資料。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9847E7D0-A9A3-0053-84C6-BA16FFFA726E",
  "ProjectName": "immtest",
  "NextToken": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==",
  "MaxResults": "1",
  "Tasks": [
    {
      "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": "VideoLabelClassification",
      "TaskId": "c2b277b9-0d30-4882-ad6d-ad661382****",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "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": 0
    }
  ]
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情