tencent cloud

文档反馈

获取工作流实例详情

最后更新时间:2023-12-30 10:49:08

    功能描述

    获取工作流实例详情。
    

    请求

    请求示例

    GET /workflowexecution/<RunId> HTTP/1.1
    Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
    Date: <GMT Date>
    Authorization: <Auth String>
    Content-Length: <length>
    Content-Type: application/xml
    说明
    Authorization: Auth String(详情请参见 请求签名 文档)。
    通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

    请求头

    此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

    请求体

    该请求的请求体为空。

    响应

    响应头

    此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

    响应体

    该响应体返回为 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
    任务状态
    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
    工作流节点的节点名称
    String

    错误码

    该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。

    实际案例

    请求

    GET /workflowexecution/i166ee19017b011eda8a5525400c540df HTTP/1.1
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
    Host: test-1234567890.ci.ap-chongqing.myqcloud.com

    响应

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 666
    Connection: keep-alive
    Date: Thu, 09 Aug 2022 16:23:12 GMT
    Server: tencent-ci
    x-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>