一、功能描述
获取工作流实例详情。
二、服务开通
使用该功能需提前 绑定存储桶,开通数据万象服务。
注意:数据万象绑定后,如果你手动对存储桶进行数据万象的解绑操作,将无法继续使用该功能。
三、使用限制
使用该接口时,请先确认相关限制条件。详情请参见 使用限制。
四、请求示例
GET /workflowexecution/<RunId> HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml
注意:说明:
五、请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
六、请求体
该请求的请求体为空。
七、响应头
此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。
八、响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response> <RequestId>NjJmMjA5MjZfZWM0YTYyNjRfN2U3ZF8yNzk1</RequestId> <WorkflowExecution> <WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId> <Name>workflow-1</Name> <RunId>i166ee19017b011eda8a5525400c540df</RunId> <CreateTime>2022-08-09T14:54:17+08:00</CreateTime> <Object>wk-test/game.mp4</Object> <State>Success</State> <Topology> <Dependencies> <Start>Transcode_1581665960537</Start> <Snapshot_1581665960536>End</Snapshot_1581665960536> <Transcode_1581665960537>Snapshot_1581665960536</Transcode_1581665960537> </Dependencies> <Nodes> <Start> <Type>Start</Type> <Input> <QueueId>p09d709939fef48a0a5c247ef39d90cec</QueueId> <ObjectPrefix>/wk-test</ObjectPrefix> <ExtFilter> <State>On</State> <Video>false</Video> <Audio>false</Audio> <ContentType>false</ContentType> <Custom>true</Custom> <CustomExts>mp4</CustomExts> <AllFile>false</AllFile> <Image>false</Image> </ExtFilter> <PicProcessQueueId>p2911917386e148639319e13c285cc774</PicProcessQueueId> </Input> </Start> <Snapshot_1581665960536> <Type>Snapshot</Type> <Operation> <TemplateId>t07740e32081b44ad7a0aea03adcffd54a</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>snapshot-${number}.jpg</Object> </Output> </Operation> </Snapshot_1581665960536> <Transcode_1581665960537> <Type>Transcode</Type> <Operation> <TemplateId>t01e57db1c2d154d2fb57aa5de9313a897</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>trans1.mp4</Object> </Output> </Operation> </Transcode_1581665960537> </Nodes> </Topology> <Tasks> <Type>Snapshot</Type> <JobId>j23c11e1e17b011edaab4ab15ec33d076</JobId> <CreateTime>2022-08-09T14:54:40+08:00</CreateTime> <Name>Snapshot_1581665960536</Name> <State>Success</State> <StartTime>2022-08-09T14:54:40+08:00</StartTime> <EndTime>2022-08-09T14:54:42+08:00</EndTime> <Code>Success</Code> <Message></Message> </Tasks> <Tasks> <Type>Transcode</Type> <JobId>j168668b217b011ed8efb27bb229e2d11</JobId> <CreateTime>2022-08-09T14:54:18+08:00</CreateTime> <Name>Transcode_1581665960537</Name> <State>Success</State> <StartTime>2022-08-09T14:54:18+08:00</StartTime> <EndTime>2022-08-09T14:54:39+08:00</EndTime> <Code>Success</Code> <Message>success</Message> </Tasks> </WorkflowExecution></Response>
具体的数据内容如下:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| RequestId | Response | 请求 ID | String |
| WorkflowExecution | Response | 工作流实例详细信息 | Container |
Container 节点 WorkflowExecution 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| WorkflowId | Response.WorkflowExecution | 工作流 ID | String |
| WorkflowName | Response.WorkflowExecution | 工作流名称 | String |
| RunId | Response.WorkflowExecution | 工作流实例 ID | String |
| CreateTime | Response.WorkflowExecution | 创建时间 | String |
| Object | Response.WorkflowExecution | COS 对象地址 | String |
| State | Response.WorkflowExecution | 工作流实例状态 | String |
| Topology | Response.WorkflowExecution | 同创建工作流接口的 Topology | Container |
| Tasks | Response.WorkflowExecution | 工作流实例任务 | Container 数组 |
Container 节点 Tasks 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| Type | Response.WorkflowExecution.Tasks | 任务所属节点类型 | String |
| State | Response.WorkflowExecution.Tasks | 任务状态,当该节点为判断节点时,PartialSuccess 表示部分输入文件通过判断 | String |
| JobId | Response.WorkflowExecution.Tasks | 任务 ID | String |
| CreateTime | Response.WorkflowExecution.Tasks | 任务创建时间 | String |
| StartTime | Response.WorkflowExecution.Tasks | 任务开始时间 | String |
| EndTime | Response.WorkflowExecution.Tasks | 任务结束时间 | String |
| Code | Response.WorkflowExecution.Tasks | 任务的错误码 | String |
| Message | Response.WorkflowExecution.Tasks | 任务的错误信息 | String |
| Name | Response.WorkflowExecution.Tasks | 工作流节点 name | String |
| ResultInfo | Response.WorkflowExecution.Tasks | 任务结果详情 | Container |
| JudgementInfo | Response.WorkflowExecution.Tasks | 判断节点结果详情,当节点为判断节点时返回 | Container |
| FileInfo | Response.WorkflowExecution.Tasks | 判断节点结果详情,当节点为判断节点时返回 | Container 数组 |
Container 节点 ResultInfo 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| ObjectCount | Response.WorkflowExecution.Tasks.ResultInfo | 任务生成对象文件个数 | String |
| SpriteObjectCount | Response.WorkflowExecution.Tasks.ResultInfo | 仅在截图生成雪碧图有效,表示生成雪碧图个数 | String |
| ObjectInfo | Response.WorkflowExecution.Tasks.ResultInfo | 任务生成对象详情 | Container 数组 |
| SpriteObjectInfo | Response.WorkflowExecution.Tasks.ResultInfo | 任务生成雪碧图对象详情 | Container 数组 |
Container 节点 SpriteObjectInfo 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| ObjectName | Response.WorkflowExecution.Tasks.ResultInfo.SpriteObjectInfo | 对象名 | String |
| ObjectUrl | Response.WorkflowExecution.Tasks.ResultInfo.SpriteObjectInfo | 对象 Url | String |
Container 节点 ObjectInfo 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| ObjectName | Response.WorkflowExecution.Tasks.ResultInfo.ObjectInfo | 对象名 | String |
| ObjectUrl | Response.WorkflowExecution.Tasks.ResultInfo.ObjectInfo | 对象 Url | String |
| InputObjectName | Response.WorkflowExecution.Tasks.ResultInfo.ObjectInfo | 输入对象名 | String |
| Code | Response.WorkflowExecution.Tasks.ResultInfo.ObjectInfo | InputObjectName 对应错误码,O为处理成功,非0处理失败 | String |
| Message | Response.WorkflowExecution.Tasks.ResultInfo.ObjectInfo | InputObjectName 对应错误信息,处理失败时有效 | String |
Container 节点 JudgementInfo 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| ObjectCount | Response.WorkflowExecution.Tasks.JudgementInfo | 判断节点输入对象文件个数 | Int |
| JudgementResult | Response.WorkflowExecution.Tasks.JudgementInfo | 判断节点输入对象具体判断结果 | Container 数组 |
Container 节点 JudgementResult 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| ObjectName | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult | 对象名 | String |
| ObjectUrl | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult | 对象链接 | String |
| State | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult | 判断结果状态,Success 表示通过条件判断,Failed 表示未通过条件判断 | String |
| InputObjectInfo | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult | 输入文件的判断参数 | Container |
Container 节点 InputObjectInfo 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| Width | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo | 视频宽 | String |
| Height | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo | 视频高 | String |
| Dar | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo | 视频宽高比 | String |
| Duration | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo | 音视频时长 | String |
| Size | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo | 文件大小 | String |
| ImageWidth | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo | 图片宽 | String |
| ImageHeight | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo | 图片高 | String |
| ImageDar | Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo | 图片宽高比 | String |
Container 节点 FileInfo 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| BasicInfo | Response.WorkflowExecution.Tasks.FileInfo | 文件基础信息 | Container |
| MediaInfo | Response.WorkflowExecution.Tasks.FileInfo | 音视频信息 | Container |
| ImageInfo | Response.WorkflowExecution.Tasks.FileInfo | 图片信息 | Container |
Container 节点 BasicInfo 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| ContentType | Response.WorkflowExecution.Tasks.FileInfo.BasicInfo | 文件类型 | String |
| Size | Response.WorkflowExecution.Tasks.FileInfo.BasicInfo | 文件大小 | String |
| ETag | Response.WorkflowExecution.Tasks.FileInfo.BasicInfo | 文件 ETag | String |
| LastModified | Response.WorkflowExecution.Tasks.FileInfo.BasicInfo | 文件上修改时间 | String |
| Object | Response.WorkflowExecution.Tasks.FileInfo.BasicInfo | 文件名 | String |
Container 节点 MediaInfo 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| Video | Response.WorkflowExecution.Tasks.FileInfo.MediaInfo | 视频信息 | Container |
| Audio | Response.WorkflowExecution.Tasks.FileInfo.MediaInfo | 音频信息 | Container |
| Format | Response.WorkflowExecution.Tasks.FileInfo.MediaInfo | 格式信息 | Container |
Container 节点 Video 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| Height | Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Video | 视频高 | String |
| Width | Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Video | 视频宽 | String |
| Dar | Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Video | 视频宽高比 | String |
| Duration | Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Video | 视频时长,单位秒 | String |
Container 节点 Audio 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| Duration | Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Audio | 音频时长,单位秒 | String |
Container 节点 Format 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| Duration | Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Format | 时长,单位秒 | String |
Container 节点 ImageInfo 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| Format | Response.WorkflowExecution.Tasks.FileInfo.ImageInfo | 图片高 | String |
| Height | Response.WorkflowExecution.Tasks.FileInfo.ImageInfo | 图片宽 | String |
| Width | Response.WorkflowExecution.Tasks.FileInfo.ImageInfo | 图片宽 | String |
| Md5 | Response.WorkflowExecution.Tasks.FileInfo.ImageInfo | 图片 Md5 | String |
| FrameCount | Response.WorkflowExecution.Tasks.FileInfo.ImageInfo | 图片帧数,静态图为1,动图为对应的帧数 | String |
九、错误码
该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。
十、请求
GET /workflowexecution/i166ee19017b011eda8a5525400c540df HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=****************************************Host: test-1234567890.ci.ap-chongqing.myqcloud.com
十一、响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 666Connection: keep-aliveDate: Thu, 09 Aug 2022 16:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response> <RequestId>NjJmMjA5MjZfZWM0YTYyNjRfN2U3ZF8yNzk1</RequestId> <WorkflowExecution> <WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId> <Name>workflow-1</Name> <RunId>i166ee19017b011eda8a5525400c540df</RunId> <CreateTime>2022-08-09T14:54:17+08:00</CreateTime> <Object>wk-test/game.mp4</Object> <State>Success</State> <Topology> <Dependencies> <Start>Transcode_1581665960537</Start> <Snapshot_1581665960536>End</Snapshot_1581665960536> <Transcode_1581665960537>Snapshot_1581665960536</Transcode_1581665960537> </Dependencies> <Nodes> <Start> <Type>Start</Type> <Input> <QueueId>p09d709939fef48a0a5c247ef39d90cec</QueueId> <ObjectPrefix>/wk-test</ObjectPrefix> <ExtFilter> <State>On</State> <Video>false</Video> <Audio>false</Audio> <ContentType>false</ContentType> <Custom>true</Custom> <CustomExts>mp4</CustomExts> <AllFile>false</AllFile> <Image>false</Image> </ExtFilter> <PicProcessQueueId>p2911917386e148639319e13c285cc774</PicProcessQueueId> </Input> </Start> <Snapshot_1581665960536> <Type>Snapshot</Type> <Operation> <TemplateId>t07740e32081b44ad7a0aea03adcffd54a</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>snapshot-${number}.jpg</Object> </Output> </Operation> </Snapshot_1581665960536> <Transcode_1581665960537> <Type>Transcode</Type> <Operation> <TemplateId>t01e57db1c2d154d2fb57aa5de9313a897</TemplateId> <Output> <Region>ap-chongqing</Region> <Bucket>test-1234567890</Bucket> <Object>trans1.mp4</Object> </Output> </Operation> </Transcode_1581665960537> </Nodes> </Topology> <Tasks> <Type>Snapshot</Type> <JobId>j23c11e1e17b011edaab4ab15ec33d076</JobId> <CreateTime>2022-08-09T14:54:40+08:00</CreateTime> <Name>Snapshot_1581665960536</Name> <State>Success</State> <StartTime>2022-08-09T14:54:40+08:00</StartTime> <EndTime>2022-08-09T14:54:42+08:00</EndTime> <Code>Success</Code> <Message></Message> </Tasks> <Tasks> <Type>Transcode</Type> <JobId>j168668b217b011ed8efb27bb229e2d11</JobId> <CreateTime>2022-08-09T14:54:18+08:00</CreateTime> <Name>Transcode_1581665960537</Name> <State>Success</State> <StartTime>2022-08-09T14:54:18+08:00</StartTime> <EndTime>2022-08-09T14:54:39+08:00</EndTime> <Code>Success</Code> <Message>success</Message> </Tasks> </WorkflowExecution>