時間範囲やタグなど、特定の条件に基づいてタスクをリスト表示します。
操作説明
この操作を呼び出す前に、Intelligent Media Management (IMM) の課金について熟知していることを確認してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
imm:ListTasks |
list |
*Project
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectName |
string |
必須 |
プロジェクトの名前です。 |
test-project |
| TaskTypes |
array |
任意 |
タスクタイプです。 |
|
|
string |
任意 |
タスクタイプです。詳細については、「タスクタイプ」をご参照ください。 |
["OfficeConversion","VideoLabelClassification"] |
|
| NextToken |
string |
任意 |
ページネーショントークンです。 結果の総数が MaxResults パラメーターの値を超えた場合、ページネーショントークンは次回のリクエストで新しい結果ページを取得するために使用されます。次回の操作呼び出しでは、NextToken パラメーター値の後に辞書順で結果が返されます。 説明
初回操作呼び出し時には、このパラメーターを空のままにしてください。 |
MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw== |
| MaxResults |
integer |
任意 |
返される結果の最大数です。有効値の範囲: (0, 100]。デフォルト値: 100。 |
1 |
| TagSelector |
string |
任意 |
タスクのカスタムタグです。 |
test=val1 |
| Sort |
string |
任意 |
結果のソートに使用されるフィールドです。有効値:
|
TaskId |
| Order |
string |
任意 |
ソート順です。有効値:
列挙値:
|
asc |
| Status |
string |
任意 |
タスクステータスです。有効値:
列挙値:
|
Succeeded |
| StartTimeRange | TimeRange |
任意 |
タスクの開始時間範囲です。このパラメーターを指定して、指定された範囲内で開始するタスクをフィルタリングできます。 |
|
| EndTimeRange | TimeRange |
任意 |
タスクの終了時間範囲です。このパラメーターを指定して、指定された範囲内で終了するタスクをフィルタリングできます。 |
|
| RequestDefinition |
boolean |
任意 |
初回タスク作成リクエストでリクエストパラメーターを返すかどうかを指定します。デフォルト値: False。 |
True |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
一致するタスクです。 |
||
| RequestId |
string |
リクエスト ID です。 |
9847E7D0-A9A3-0053-84C6-BA16FFFA726E |
| ProjectName |
string |
プロジェクトの名前です。 |
immtest |
| NextToken |
string |
ページネーショントークンです。結果の総数が MaxResults パラメーターの値を超えた場合、ページネーショントークンは次回のリクエストで新しい結果ページを取得するために使用されます。このパラメーターは、すべての結果が返されない場合にのみ値を持っています。 NextToken パラメーターの値を指定することで、次回のリクエストで残りの結果をリスト表示できます。 |
MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw== |
| MaxResults |
string |
返される結果リストの長さです。 |
1 |
| Tasks |
array |
タスクです。 |
|
| TaskInfo |
タスクの詳細です。 |
例
成功レスポンス
JSONJSON
{
"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
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。