ワークフロータスクを取得します。
操作説明
この API では、過去 90 日間のデータのみが返されます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:ListWorkflowTasks |
list |
*All Resource
|
なし | なし |
リクエスト構文
GET HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WorkflowId |
string |
任意 |
|
******b4fb044839815d4f2cd8****** |
| WorkflowName |
string |
任意 |
ワークフローテンプレートの名前です。 |
example-workflow-**** |
| KeyText |
string |
任意 |
TaskInput に対するあいまい一致検索に使用するキーワード（例：ファイル名またはメディア ID）。最大長：32 文字。 |
******7aa4cc4459ada8ef35f7****** 或 **TestVideo***.flv |
| StartOfCreateTime |
string |
任意 |
タスク作成時刻によるフィルター処理の開始時刻です。過去 90 日間のデータのみクエリ可能です。 |
2025-07-12T00:00:00Z |
| EndOfCreateTime |
string |
任意 |
タスク作成時刻によるフィルター処理の終了時刻です。過去 90 日間のデータのみクエリ可能です。 |
2025-07-15T00:00:00Z |
| MaxResults |
integer |
任意 |
返されるメディアワークフローインスタンスの最大数です。有効値：1～100。デフォルト値：10。 |
10 |
| NextToken |
string |
任意 |
次のページの結果を取得するために、次回のリクエストで使用するページネーショントークンです。初回リクエストでは、このパラメーターを指定する必要はありません。 |
**************VRpbWUQARgBIpcBCgkA1bUtaAAAAAAKiQEDhAAAADFTMzg2NTY2NjU2MzM3NjU2NjYyMzkzMTYyMzI2MjYzNjY2********** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマです。 |
||
| TotalCount |
integer |
返されたエントリの合計数です。デフォルトでは、このパラメーターは返されません。 |
4 |
| RequestId |
string |
リクエストの ID です。 |
C0C02296-113C-5838-8FE9-8F3A32998DDC |
| NextToken |
string |
ページネーショントークンです。 |
****8EqYpQbZ6Eh7+Zz8DxVYoQ== |
| TaskList |
array<object> |
メディアワークフロータスクです。 |
|
|
array<object> |
ワークフロータスクの詳細です。 |
||
| TaskId |
string |
ワークフロータスクの ID です。 |
*****4c93d2f404f8345b16a965***** |
| TaskInput |
string |
ワークフロータスクの入力データです。 |
{\"Type\":\"Media\",\"Media\":\"****8b40884171efb0d9e7f7f458****\"} |
| Status |
string |
タスクの状態です。 有効な値：
|
Succeed |
| CreateTime |
string |
タスクの作成時刻です。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表記されます。時刻は協定世界時 (UTC) で表示されます。 |
2024-07-15T09:45:48Z |
| FinishTime |
string |
タスクの完了時刻です。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表記されます。時刻は協定世界時 (UTC) で表示されます。 |
2024-12-07T10:53:45Z |
| Workflow |
object |
ワークフローテンプレートに関する情報です。 |
|
| WorkflowId |
string |
ワークフロー ID です。 |
******2491c84dce913da9fe65****** |
| Name |
string |
ワークフローテンプレートの名前です。 |
example-workflow-*** |
| Status |
string |
ワークフローテンプレートのステータスです。 |
Active |
| Type |
string |
ワークフローテンプレートのタイプです。 |
Common |
| CreateTime |
string |
ワークフローテンプレートの作成時刻です。 |
2025-03-21T01:48:49Z |
| ModifiedTime |
string |
ワークフローテンプレートの最終更新時刻です。 |
2025-02-23 10:19:37 +0800 |
| MediaType |
string |
メディアファイルのソースです。有効な値：
|
OSS |
| UserData |
string |
タスク送信時に渡されたカスタムデータです。 |
{"NotifyAddress":"http://xx.xx.xxx"} |
| MaxResults |
integer |
この応答で返されるエントリの最大数です。 |
10 |
例
成功レスポンス
JSONJSON
{
"TotalCount": 4,
"RequestId": "C0C02296-113C-5838-8FE9-8F3A32998DDC",
"NextToken": "****8EqYpQbZ6Eh7+Zz8DxVYoQ==",
"TaskList": [
{
"TaskId": "*****4c93d2f404f8345b16a965*****",
"TaskInput": "{\\\"Type\\\":\\\"Media\\\",\\\"Media\\\":\\\"****8b40884171efb0d9e7f7f458****\\\"}",
"Status": "Succeed",
"CreateTime": "2024-07-15T09:45:48Z",
"FinishTime": "2024-12-07T10:53:45Z",
"Workflow": {
"WorkflowId": "******2491c84dce913da9fe65******",
"Name": "example-workflow-***",
"Status": "Active",
"Type": "Common",
"CreateTime": "2025-03-21T01:48:49Z",
"ModifiedTime": "2025-02-23 10:19:37 +0800",
"MediaType": "OSS"
},
"UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\"}"
}
],
"MaxResults": 10
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。