tencent cloud

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

Feature Description

Get workflow instance list.

Authorization Description

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

Service Activation

Using this feature requires enabling Cloud Infinite in advance and binding 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 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 Request Signature document.

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.

Request parameters.

Parameter Name (Keyword)
Description
Type
Required or Not
workflowId
workflow ID
String
No
name
File Name
String
No
orderByTime
Desc or Asc. Default is Desc.
String
No
size
Maximum number of tasks to pull. Default is 10. Maximum is 100.
String
No
states
workflow instance status, separated by ,, supports multiple statuses
All, Success, Failed, Running, Cancel. Default is All.
String
No
startCreationTime
Pull instances created at or after this time. Format: %Y-%m-%dT%H:%M:%S%z
String
No
endCreationTime
Pull instances created at or before this time. Format: %Y-%m-%dT%H:%M:%S%z
String
No
nextToken
Request context, used for pagination. Next page input token.
String
No
jobId
Batch trigger workflow task IDs, used for scanning out workflow instances executed by the corresponding batch-triggered task IDs.
String
No

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>NjJmMjEyMmFfZWM0YTYyNjRfN2U2NV8yNmI0</RequestId>
    <WorkflowExecutionList>
        <RunId>i166ee19017b011eda8a5525400c540df</RunId>
        <WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId>
        <Object>wk-test/game.mp4</Object>
        <CreateTime>2022-08-09T14:54:17+08:00</CreateTime>
        <State>Success</State>
    </WorkflowExecutionList>
    <WorkflowExecutionList>
        <RunId>i769bd26517af11ed917f525400a3c59f</RunId>
        <WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId>
        <Object>wk-test/game.mp4</Object>
        <CreateTime>2022-08-09T14:49:49+08:00</CreateTime>
        <State>Success</State>
    </WorkflowExecutionList>
    <NextToken>115716</NextToken>
</Response>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container to save results
Container
Container node Response content:
Node Name (Keyword)
Parent Node
Description
Type
WorkflowExecutionList
Response
Workflow instance details
Container
RequestId
Response
Request ID
String
NextToken
Response
Pagination context Token
String
Content of the Container node WorkflowExecutionList:
Node Name (Keyword)
Parent Node
Description
Type
RunId
Response.WorkflowExecutionList
Workflow instance ID
String
WorkflowId
Response.WorkflowExecutionList
workflow ID
String
State
Response.WorkflowExecutionList
Workflow instance status
String
CreateTime
Response.WorkflowExecutionList
Creation time
String
Object
Response.WorkflowExecutionList
COS object address
String

Error Codes

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

Examples

Request

GET /workflowexecution?workflowId=web6ac56c1ef54dbfa44d7f4103203be9 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: NjJmMjEyMmFfZWM0YTYyNjRfN2U2NV8yNmI0

<Response>
    <RequestId>NjJmMjEyMmFfZWM0YTYyNjRfN2U2NV8yNmI0</RequestId>
    <WorkflowExecutionList>
        <RunId>i166ee19017b011eda8a5525400c540df</RunId>
        <WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId>
        <Object>wk-test/game.mp4</Object>
        <CreateTime>2022-08-09T14:54:17+08:00</CreateTime>
        <State>Success</State>
    </WorkflowExecutionList>
    <WorkflowExecutionList>
        <RunId>i769bd26517af11ed917f525400a3c59f</RunId>
        <WorkflowId>web6ac56c1ef54dbfa44d7f4103203be9</WorkflowId>
        <Object>wk-test/game.mp4</Object>
        <CreateTime>2022-08-09T14:49:49+08:00</CreateTime>
        <State>Success</State>
    </WorkflowExecutionList>
    <NextToken>115716</NextToken>
</Response>

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

Feedback