ListWorkflowTasks - 遍历工作流任务实例 - 智能媒体服务

遍历工作流任务实例。

接口说明

本接口只返回近 90 天执行实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListWorkflowTasks

list

*全部资源

*

无

请求语法

GET  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
WorkflowId	string	否	工作流模板 ID。您可通过智能媒体服务控制台> 配置管理 > 工作流模板，查看模板 ID。	****b4fb044839815d4f2cd8****
WorkflowName	string	否	工作流模板名称。	example-workflow-****
KeyText	string	否	文件名或者媒资 id 等，支持对 TaskInput 进行模糊查询，最大长度 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	Schema of Response
TotalCount	integer	TotalCount 本次请求条件下的数据总量，此参数为可选参数，默认可不返回	4
RequestId	string	请求 ID	C0C02296-113C-5838-8FE9-8F3A32998DDC
NextToken	string	下一页标识	****8EqYpQbZ6Eh7+Zz8DxVYoQ==
TaskList	array<object>	媒体工作流任务列表
	array<object>	MediaServiceWorkflowTask - 工作流任务详细信息
TaskId	string	工作流任务 Id	***4c93d2f404f8345b16a965***
TaskInput	string	工作流任务输入	{\"Type\":\"Media\",\"Media\":\"**8b40884171efb0d9e7f7f458**\"}
Status	string	任务状态。枚举值 Init：任务初始化。 Failed：失败。 Canceled：任务已取消。 Processing：任务执行中。 Succeed：成功。	Succeed
CreateTime	string	任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。	2024-07-15T09:45:48Z
FinishTime	string	任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。	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：oss 文件 Media：媒资	OSS
UserData	string	用户提交工作流任务时设置的自定义字段。	{"NotifyAddress":"http://xx.xx.xxx"}
MaxResults	integer	本次请求所返回的最大任务条数	10

示例

正常返回示例

JSON格式

{
  "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
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。