GetWorkflowTask - 查询工作流任务

根据任务ID查询工作流任务,包括工作流Id、工作流任务状态、工作流任务结果。 本接口仅支持查询近一年的工作流任务数据。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:GetWorkflowTaskget
*全部资源
*

请求参数

名称类型必填描述示例值
TaskIdstring

工作流任务 Id

******4215e042b3966ca5441e******

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

******0C-7870-15FE-B96F-8880BB******
WorkflowTaskobject

工作流任务信息

TaskIdstring

工作流任务 ID

******4215e042b3966ca5441e******
Statusstring

任务状态

枚举值:
  • Init任务初始化
  • Failed失败
  • Canceled任务已取消
  • Processing任务执行中
  • Succeed成功
Succeed
TaskInputstring

工作流任务输入

{ "Type": "Media", "Media": "******30706071edbfe290b488******" }
CreateTimestring

任务创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

2023-01-04T02:05:17Z
FinishTimestring

任务完成时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。

2023-01-04T02:06:19Z
Workflowobject

工作流信息

WorkflowIdstring

工作流 ID

******63dca94c609de02ac0d1******
Namestring

工作流名称

超分转码工作流
Statusstring

工作流状态

枚举值:
  • Active启用
  • Inactive禁用
Active
Typestring

工作流类型

枚举值:
  • Customize定制工作流
  • System系统工作流
  • Common用户创建工作流
Common
CreateTimestring

工作流创建时间

2022-11-27T10:02:12Z
ModifiedTimestring

工作流最后修改时间

2022-11-29T02:06:19Z
ActivityResultsstring

工作流任务各节点结果。

Json格式,内容根据工作流配置有变化。
UserDatastring

用户提交工作流任务时设置的自定义字段。

{"NotifyAddress":"http://xx.xx.xxx"}

示例

正常返回示例

JSON格式

{
  "RequestId": "******0C-7870-15FE-B96F-8880BB******",
  "WorkflowTask": {
    "TaskId": "******4215e042b3966ca5441e******",
    "Status": "Succeed",
    "TaskInput": "{\n      \"Type\": \"Media\",\n      \"Media\": \"******30706071edbfe290b488******\"\n}",
    "CreateTime": "2023-01-04T02:05:17Z",
    "FinishTime": "2023-01-04T02:06:19Z",
    "Workflow": {
      "WorkflowId": "******63dca94c609de02ac0d1******",
      "Name": "超分转码工作流",
      "Status": "Active",
      "Type": "Common",
      "CreateTime": "2022-11-27T10:02:12Z",
      "ModifiedTime": "2022-11-29T02:06:19Z\n"
    },
    "ActivityResults": "Json格式,内容根据工作流配置有变化。",
    "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\"}"
  }
}

错误码

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