該接口提供通過多種條件查詢?nèi)蝿?wù)列表的功能。通過該接口可以查詢指定時(shí)間范圍內(nèi)的任務(wù)、或者通過創(chuàng)建任務(wù)時(shí)指定的Tag搜索任務(wù)等。
接口說明
請(qǐng)確保在使用該接口前，已充分了解智能媒體管理產(chǎn)品的收費(fèi)方式和價(jià)格。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| imm:ListTasks | list |
|
| 無 |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 項(xiàng)目名稱，獲取方式請(qǐng)參見創(chuàng)建項(xiàng)目。 | test-project |
| TaskTypes | array | 否 | 查詢的任務(wù)類型列表。 | |
| string | 否 | 任務(wù)類型。取值范圍請(qǐng)參見任務(wù)類型列表。 | ["OfficeConversion","VideoLabelClassification"] | |
| NextToken | string | 否 | 翻頁標(biāo)記。 當(dāng)文件總數(shù)大于設(shè)置的 MaxResults 時(shí)，用于翻頁的 Token。從 NextToken 開始按字典序返回文件信息列表。 說明
在一次查詢中首次調(diào)用此接口時(shí)，將此值設(shè)置為空。
| MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw== |
| MaxResults | long | 否 | 返回結(jié)果列表中最大任務(wù)數(shù)量。取值范圍為（0，100 ]，默認(rèn)值為 100。 | 1 |
| TagSelector | string | 否 | 自定義任務(wù)標(biāo)簽。在創(chuàng)建任務(wù)時(shí)如果指定了“Tag”參數(shù)，可以通過此參數(shù)進(jìn)行搜索。 | test=val1 |
| Sort | string | 否 | 返回的任務(wù)信息列表排序規(guī)則。取值范圍如下：
| TaskId |
| Order | string | 否 | 排序方式。取值范圍如下：
| ASC |
| Status | string | 否 | 任務(wù)運(yùn)行狀態(tài)。取值范圍如下：
| Succeeded |
| StartTimeRange | TimeRange | 否 | 任務(wù)開始的時(shí)間范圍?？珊Y選某段時(shí)間內(nèi)開始執(zhí)行的任務(wù)。 | |
| EndTimeRange | TimeRange | 否 | 任務(wù)結(jié)束的時(shí)間范圍?？珊Y選某段時(shí)間內(nèi)結(jié)束執(zhí)行的任務(wù)。 | |
| RequestDefinition | boolean | 否 | 是否需要返回創(chuàng)建任務(wù)的初始請(qǐng)求參數(shù)，默認(rèn)值為 False。 | True |
返回參數(shù)
示例
正常返回示例
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": "",
"Progress": 0
}
]
}錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2023-05-11 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |