tencent cloud

Getting Workflow Instance Details
Last updated: 2025-09-09 20:46:30
Getting Workflow Instance Details
Last updated: 2025-09-09 20:46:30

Feature Description

Retrieve workflow instance details.

Authorization Description

When used by a sub-account, the ci:DescribeMediaWorkflowExecutions permission is required. For details, see Cloud Infinite action.

Activating a Service

To use this feature, you need to enable Cloud Infinite in advance and bind a bucket. For details, see Binding a Bucket.

Use Limits

When using this API, please first confirm the relevant restrictions. For details, see Usage Limits.


Request

Request sample

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
Note:
Authorization: Auth String. For details, see the Request Signature document.
RunId is the workflow instance id.

Request header

This API only uses common request headers. For details, see Common Request Headers documentation.

Request body

The request does not have a request body.

Response

Response Headers

This API only returns the public response header. For details, see Common Response Headers documentation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<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>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node Response content:
Node Name (Keyword)
Parent Node
Description
Type
RequestId
Response
request ID
String
WorkflowExecution
Response
Workflow instance details
Container
Container node WorkflowExecution content:
Node Name (Keyword)
Parent Node
Description
Type
WorkflowId
Response.WorkflowExecution
workflow ID
String
WorkflowName
Response.WorkflowExecution
workflow name
String
RunId
Response.WorkflowExecution
workflow instance ID
String
CreateTime
Response.WorkflowExecution
Creation time
String
Object
Response.WorkflowExecution
COS object address
String
State
Response.WorkflowExecution
Workflow instance status
String
Topology
Response.WorkflowExecution
Container
Tasks
Response.WorkflowExecution
Workflow instance task
Container array
Container node Tasks content:
Node Name (Keyword)
Parent Node
Description
Type
Type
Response.WorkflowExecution.Tasks
Task associated node type
String
State
Response.WorkflowExecution.Tasks
status of tasks, when the node is a judgment node, PartialSuccess indicates partial input files pass the judgment
String
JobId
Response.WorkflowExecution.Tasks
Task ID
String
CreateTime
Response.WorkflowExecution.Tasks
Task Creation Time
String
StartTime
Response.WorkflowExecution.Tasks
Task Started At
String
EndTime
Response.WorkflowExecution.Tasks
Task Closed At
String
Code
Response.WorkflowExecution.Tasks
Task Error Code
String
Message
Response.WorkflowExecution.Tasks
Task error information
String
Name
Response.WorkflowExecution.Tasks
Workflow Node name
String
ResultInfo
Response.WorkflowExecution.Tasks
task result details
Container
JudgementInfo
Response.WorkflowExecution.Tasks
Judgment Node Result Details, returned when the node is a judgment node
Container
FileInfo
Response.WorkflowExecution.Tasks
Judgment Node Result Details (returned when the node is a judgment node)
Container array
Container node ResultInfo content:
Node Name (Keyword)
Parent Node
Description
Type
ObjectCount
Response.WorkflowExecution.Tasks.ResultInfo
Number of files for task generation objects
String
SpriteObjectCount
Response.WorkflowExecution.Tasks.ResultInfo
Valid only for generating image sprites from screenshots Indicates the number of generated image sprites
String
ObjectInfo
Response.WorkflowExecution.Tasks.ResultInfo
Object details for task generation
Container array
SpriteObjectInfo
Response.WorkflowExecution.Tasks.ResultInfo
Object details for task generation sprite sheet
Container array
Container node SpriteObjectInfo content:
Node Name (Keyword)
Parent Node
Description
Type
ObjectName
Response.WorkflowExecution.Tasks.ResultInfo.SpriteObjectInfo
Object Name
String
ObjectUrl
Response.WorkflowExecution.Tasks.ResultInfo.SpriteObjectInfo
Object Url
String
Container node ObjectInfo content:
Node Name (Keyword)
Parent Node
Description
Type
ObjectName
Response.WorkflowExecution.Tasks.ResultInfo.ObjectInfo
Object Name
String
ObjectUrl
Response.WorkflowExecution.Tasks.ResultInfo.ObjectInfo
Object Url
String
InputObjectName
Response.WorkflowExecution.Tasks.ResultInfo.ObjectInfo
Input Object Name
String
Code
Response.WorkflowExecution.Tasks.ResultInfo.ObjectInfo
InputObjectName corresponding error code, 0: processing successful; non-zero: processing failure
String
Message
Response.WorkflowExecution.Tasks.ResultInfo.ObjectInfo
InputObjectName corresponding error information, valid when processing fails
String
Container node JudgementInfo content:
Node Name (Keyword)
Parent Node
Description
Type
ObjectCount
Response.WorkflowExecution.Tasks.JudgementInfo
Number of input object files for the judgment node
Int
JudgementResult
Response.WorkflowExecution.Tasks.JudgementInfo
Specific judgment result of the judgment node's input object
Container array
Container node JudgementResult content:
Node Name (Keyword)
Parent Node
Description
Type
ObjectName
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult
Object Name
String
ObjectUrl
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult
Object link
String
State
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult
Judgment result status, Success indicates passing conditional judgment, Failed indicates failing conditional judgment
String
InputObjectInfo
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult
Input file judgment parameter
Container
Container node InputObjectInfo content:
Node Name (Keyword)
Parent Node
Description
Type
Width
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo
video width
String
Height
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo
Video height
String
Dar
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo
video aspect ratio
String
Duration
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo
audio and video duration
String
Size
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo
File Size
String
ImageWidth
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo
image width
String
ImageHeight
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo
Image height
String
ImageDar
Response.WorkflowExecution.Tasks.JudgementInfo.JudgementResult.InputObjectInfo
image aspect ratio
String
Container node FileInfo content:
Node Name (Keyword)
Parent Node
Description
Type
BasicInfo
Response.WorkflowExecution.Tasks.FileInfo
Basic file information
Container
MediaInfo
Response.WorkflowExecution.Tasks.FileInfo
audio and video information
Container
ImageInfo
Response.WorkflowExecution.Tasks.FileInfo
Image information
Container
Container node BasicInfo content:
Node Name (Keyword)
Parent Node
Description
Type
ContentType
Response.WorkflowExecution.Tasks.FileInfo.BasicInfo
File Type
String
Size
Response.WorkflowExecution.Tasks.FileInfo.BasicInfo
File Size
String
ETag
Response.WorkflowExecution.Tasks.FileInfo.BasicInfo
File Etag
String
LastModified
Response.WorkflowExecution.Tasks.FileInfo.BasicInfo
Last modified time of the file
String
Object
Response.WorkflowExecution.Tasks.FileInfo.BasicInfo
File Name
String
Container node MediaInfo content:
Node Name (Keyword)
Parent Node
Description
Type
Video
Response.WorkflowExecution.Tasks.FileInfo.MediaInfo
video information
Container
Audio
Response.WorkflowExecution.Tasks.FileInfo.MediaInfo
audio content
Container
Format
Response.WorkflowExecution.Tasks.FileInfo.MediaInfo
format information
Container
Container node Video content:
Node Name (Keyword)
Parent Node
Description
Type
Height
Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Video
Video height
String
Width
Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Video
video width
String
Dar
Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Video
video aspect ratio
String
Duration
Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Video
video duration, in seconds
String
Container node Audio content:
Node Name (Keyword)
Parent Node
Description
Type
Duration
Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Audio
audio duration, in seconds
String
Container node Formt content:
Node Name (Keyword)
Parent Node
Description
Type
Duration
Response.WorkflowExecution.Tasks.FileInfo.MediaInfo.Format
duration, in seconds
String
Container node ImageInfo content:
Node Name (Keyword)
Parent Node
Description
Type
Format
Response.WorkflowExecution.Tasks.FileInfo.ImageInfo
Image height
String
Height
Response.WorkflowExecution.Tasks.FileInfo.ImageInfo
image width
String
Width
Response.WorkflowExecution.Tasks.FileInfo.ImageInfo
image width
String
Md5
Response.WorkflowExecution.Tasks.FileInfo.ImageInfo
Image Md5
String
FrameCount
Response.WorkflowExecution.Tasks.FileInfo.ImageInfo
Frame number, 1 for static images and corresponding number of frames for dynamic images
String

Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

Examples

Request

GET /workflowexecution/i166ee19017b011eda8a5525400c540df HTTP/1.1
Authorization: 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

Response

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>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback