You need to enable JavaScript to run this app.
Torch Object Storage

Torch Object Storage

Copy page
Download PDF
Workflow
ListWorkflowExecution
Copy page
Download PDF
ListWorkflowExecution
Description​
This interface lists all workflow execution records under the current account.​
Notes​
None.​
Request syntax​
​
GET /?workflow_execution&states=success&order_by_time=asc HTTP/1.1​
Host: bucketname.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: authorization string​
​
Request parameters and headers ​
​
Field name​
Location​
Type​
Required​
Example value​
Description​
workflow_execution​
Query​
String​
Yes​
-​
Represents a special identifier for the ListWorkflowExecution request.​
workflow_id​
Query​
String​
No​
1840df030b38571c52470001b393c48b****​
Workflow execution record ID.​
start_time​
Query​
String​
No​
2025-05-19T16:31:29+08:00​
Workflow execution start time.​
end_time​
Query​
String​
No​
2025-05-19T16:31:30+08:00​
Workflow execution end time.​
state​
Query​
String​
No​
All​
Status of workflow execution, with the following possible values:​
  • all: all execution records.​
  • success: records that executed successfully.​
  • failed: records that failed to execute.​
  • running: records currently executing.​
  • cancel: records that have been canceled.​
order_by_time​
Query​
String​
No​
desc​
Workflow execution record display order is explained as follows:​
  • desc: in descending order of time.​
  • asc: in ascending order of time.​
page_size​
Query​
String​
No​
3​
Page size.​
page_token​
Query​
String​
No​
1840df030b38571c52470001b393c48b****​
Query start position.​
​
Request body elements​
No elements are used.​
Response headers​
The response contains common headers. For more information, see Common Parameters.​
Response body elements​
​
Field name​
Type​
Example value​
Description​
Items​
Content​
-​
Execution record information.​
ExecutionID​
String​
1840df030b38571c52470001b393c48b****​
Execution record ID.​
Parent node: Items​
RequestID​
String​
-​
The request ID.​
Parent node: Items​
Object​
String​
bbb/sample.wav​
Workflow source file name.​
Parent node: Items​
Workflow​
Content​
-​
Workflow information.​
Parent node: Items​
ID​
String​
my-wf-rule-1​
Name of the workflow.​
Parent node: Workflow​
Enabled​
String​
true​
Workflow status. The options are as follows:​
  • true: Enable the workflow. Once an object is uploaded to the specified path, the workflow executes automatically.​
  • false: Disable the workflow.​
Parent node: Workflow​
Prefix​
String​
bbb/​
Path bound to the workflow.​
Uploading files to this path triggers the workflow execution. If unspecified, the entire bucket is bound, and uploading files to the bucket triggers the workflow execution.​
Parent node: Workflow​
ExtFilter​
Content​
-​
media type.​
parent node: Workflow​
AudioExts​
String​
wav​
Media type.​
Only this media type can trigger workflow execution. Currently, only the value wav is supported.​
Parent node: ExtFilter​
Topology​
String​
1​
Template names included in the workflow.​
Parent node: Workflow​
Operations​
Content​
-​
Template information.​
Parent node: Workflow​
AudioTranscode​
Content​
-​
Audio transcoding template information.​
Parent node: Operations​
OperationID​
String​
my-op-1​
Name of the workflow template.​
Parent node: AudioTranscode​
Format​
String​
mp3​
Transcoding output format, currently only supports mp3.​
Parent node: AudioTranscode​
Bitrate​
Number​
128000​
Transcode bitrate, currently only supports the value 128000.​
Parent node: AudioTranscode​
Output​
Content​
-​
File storage location.​
Parent node: AudioTranscode​
Region​
String​
cn-beijing​
Region where the transcoded audio file is stored.​
Parent node: Output​
Bucket​
String​
test​
The storage bucket for transcoded audio files.​
Parent node: Output​
Object​
String​
data.mp3​
Name of the transcoded audio file.​
Parent node: Output​
State​
String​
Success​
The status of the workflow execution.​
Parent node: Items​
CreateTime​
String​
2025-05-19T16:31:29+08:00​
Workflow creation time.​
Parent node: Items​
StartTime​
String​
2025-05-19T16:31:29+08:00​
Workflow execution start time.​
Parent node: Items​
EndTime​
String​
2025-05-19T16:31:30+08:00​
Workflow execution end time.​
Parent node: Items​
Tasks​
Content​
-​
Workflow template execution information.​
Parent node: Items​
Type​
String​
AudioTranscode​
Workflow template type.​
Parent node: Tasks​
JobID​
String​
1840e07ea084b82408820001f48e6010****-0​
workflow task ID.​
parent node: Tasks​
OperationID​
String​
my-op-1​
Workflow template name.​
Parent node: Tasks​
State​
String​
Success​
Workflow template execution status.​
Parent node: Tasks​
CreateTime​
String​
2025-05-19T16:31:29+08:00​
Workflow template creation time.​
Parent node: Tasks​
StartTime​
String​
2025-05-19T16:31:29+08:00​
Workflow template execution start time.​
Parent node: Tasks​
EndTime​
String​
2025-05-19T16:31:30+08:00​
workflow template execution end time.​
parent node: Tasks​
Code​
String​
0​
Error code.​
Parent node: Tasks​
Message​
String​
-​
Error message.​
Parent node: Tasks​
NextPageToken​
String​
-​
Position of the next page data.​
​
Sample request​
​
GET /?workflow_execution&states=success&order_by_time=asc HTTP/1.1​
Host: bucketname.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: authorization string​
​
Sample response​
​
HTTP/1.1 200 OK​
Date: Fri, 30 Jul 2021 13:53:55 GMT​
Server: TosServer​
x-tos-id-2: 1e89f203jld00006-a444fd0​
x-tos-request-id: 1e89f203b2d00006-a444ed0​
Content-Length: 643​
{​
"Items": [​
{​
"ExecutionID": "1840df030b38571c52470001b393c48b****",​
"RequestID": "",​
"Object": "bbb/sample.wav",​
"Workflow": {​
"ID": "my-wf-rule-1",​
"Enabled": true,​
"Prefix": "bbb/",​
"ExtFilter": {​
"AudioExts": [​
"wav"​
]​
},​
"Topology": [​
[​
"my-op-1"​
]​
],​
"Operations": {​
"AudioTranscode": [​
{​
"OperationID": "my-op-1",​
"Format": "mp3",​
"Bitrate": 128000,​
"Output": {​
"Region": "cn-beijing",​
"Bucket": "bbb",​
"Object": "123.mp3"​
}​
}​
]​
}​
},​
"State": "Success",​
"CreateTime": "2025-05-19T16:04:19+08:00",​
"StartTime": "2025-05-19T16:04:19+08:00",​
"EndTime": "2025-05-19T16:04:19+08:00",​
"Tasks": [​
{​
"Type": "AudioTranscode",​
"JobID": "1840df030b38571c52470001b393c48b****-0",​
"OperationID": "my-op-1",​
"State": "Success",​
"CreateTime": "2025-05-19T16:04:19+08:00",​
"StartTime": "2025-05-19T16:04:19+08:00",​
"EndTime": "2025-05-19T16:04:19+08:00",​
"Error": "",​
"Code": 0,​
"Message": ""​
}​
]​
},​
{​
"ExecutionID": "1840e07ea084b82408820001f48e6010****",​
"RequestID": "",​
"Object": "bbb/aaa/sample.wav",​
"Workflow": {​
"ID": "my-wf-rule-1",​
"Enabled": true,​
"Prefix": "bbb/",​
"ExtFilter": {​
"AudioExts": [​
"wav"​
]​
},​
"Topology": [​
[​
"my-op-1"​
]​
],​
"Operations": {​
"AudioTranscode": [​
{​
"OperationID": "my-op-1",​
"Format": "mp3",​
"Bitrate": 128000,​
"Output": {​
"Region": "cn-beijing",​
"Bucket": "bbb",​
"Object": "123.mp3"​
}​
}​
]​
}​
},​
"State": "Success",​
"CreateTime": "2025-05-19T16:31:29+08:00",​
"StartTime": "2025-05-19T16:31:29+08:00",​
"EndTime": "2025-05-19T16:31:30+08:00",​
"Tasks": [​
{​
"Type": "AudioTranscode",​
"JobID": "1840e07ea084b82408820001f48e6010****-0",​
"OperationID": "my-op-1",​
"State": "Success",​
"CreateTime": "2025-05-19T16:31:29+08:00",​
"StartTime": "2025-05-19T16:31:29+08:00",​
"EndTime": "2025-05-19T16:31:30+08:00",​
"Error": "",​
"Code": 0,​
"Message": ""​
}​
]​
}​
],​
"NextPageToken": ""​
}​
​
​
Last updated: 2025.12.03 16:14:57