You need to enable JavaScript to run this app.
文档中心
对象存储

对象存储

复制全文
下载 pdf
工作流
ListWorkflowExecution
复制全文
下载 pdf
ListWorkflowExecution
功能描述​
此接口用于列举当前账号下所有的工作流执行记录。​
注意事项​
无。​
请求消息样式​
​
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​
​
请求参数和消息头​
​
名称​
位置​
参数类型​
是否必选​
示例值​
说明​
workflow_execution​
Query​
String​
是​
-​
代表 ListWorkflowExecution 请求的特殊标识。​
workflow_id​
Query​
String​
否​
1840df030b38571c52470001b393c48b****​
工作流执行记录 ID。​
start_time​
Query​
String​
否​
2025-05-19T16:31:29+08:00​
工作流执行开始时间。​
end_time​
Query​
String​
否​
2025-05-19T16:31:30+08:00​
工作流执行结束时间。​
state​
Query​
String​
否​
All​
工作流执行的状态,取值说明如下:​
  • all:全部执行记录。​
  • success:执行成功的记录。​
  • failed:执行失败的记录。​
  • running:执行中的记录。​
  • cancel:已取消的记录。​
order_by_time​
Query​
String​
否​
desc​
工作流执行记录展示顺序,说明如下:​
  • desc :按时间降序。​
  • asc:按时间升序。​
page_size​
Query​
String​
否​
3​
页大小。​
page_token​
Query​
String​
否​
1840df030b38571c52470001b393c48b****​
查询开始的位置。​
​
请求元素​
该请求不使用消息元素。​
响应消息头​
该请求返回的公共响应消息头,请参见公共参数。​
响应元素​
​
名称​
参数类型​
示例值​
说明​
Items​
Content​
-​
执行记录信息。​
ExecutionID​
String​
1840df030b38571c52470001b393c48b****​
执行记录 ID。​
父节点:Items​
RequestID​
String​
-​
请求 ID。​
父节点:Items​
Object​
String​
bbb/sample.wav​
工作流源文件名称。​
父节点:Items​
Workflow​
Content​
-​
工作流信息。​
父节点:Items​
ID​
String​
my-wf-rule-1​
工作流的名称。​
父节点:Workflow​
Enabled​
String​
true​
工作流状态。取值说明如下:​
  • true:启用工作流,上传对象到指定路径下后,将自动执行工作流。​
  • false:停止工作流。​
父节点:Workflow​
Prefix​
String​
bbb/​
工作流绑定的路径.​
文件上传到该路径下,才会触发执行工作流。如果未指定,表示绑定整个存储桶,文件上传到存储桶,就会触发执行工作流。​
父节点:Workflow​
ExtFilter​
Content​
-​
媒体类型。​
父节点:Workflow​
AudioExts​
String​
wav​
媒体类型.​
仅该类型的媒体可以触发执行工作流,当前仅支持取值 wav。​
父节点:ExtFilter​
Topology​
String​
1​
工作流包含的模版名称。​
父节点:Workflow​
Operations​
Content​
-​
模版信息。​
父节点:Workflow​
AudioTranscode​
Content​
-​
音频转码模版信息。​
父节点:Operations​
OperationID​
String​
my-op-1​
工作流模版名称。​
父节点:AudioTranscode​
Format​
String​
mp3​
转码输出格式,当前仅支持取值 mp3。​
父节点:AudioTranscode​
Bitrate​
Number​
128000​
转码码率,当前仅支持取值 128000。​
父节点:AudioTranscode​
Output​
Content​
-​
文件存储的位置。​
父节点:AudioTranscode​
Region​
String​
cn-beijing​
转码后音频文件存储的地域。​
父节点:Output​
Bucket​
String​
test​
存储转码后音频文件的存储桶。​
父节点:Output​
Object​
String​
data.mp3​
转码后音频文件的名称。​
父节点:Output​
State​
String​
Success​
工作流执行的状态。​
父节点:Items​
CreateTime​
String​
2025-05-19T16:31:29+08:00​
工作流创建时间。​
父节点:Items​
StartTime​
String​
2025-05-19T16:31:29+08:00​
工作流执行开始时间。​
父节点:Items​
EndTime​
String​
2025-05-19T16:31:30+08:00​
工作流执行结束时间。​
父节点:Items​
Tasks​
Content​
-​
工作流模板执行信息。​
父节点:Items​
Type​
String​
AudioTranscode​
工作流模版类型。​
父节点:Tasks​
JobID​
String​
1840e07ea084b82408820001f48e6010****-0​
工作流任务 ID。​
父节点:Tasks​
OperationID​
String​
my-op-1​
工作流模版名称。​
父节点:Tasks​
State​
String​
Success​
工作流模版执行状态。​
父节点:Tasks​
CreateTime​
String​
2025-05-19T16:31:29+08:00​
工作流模版创建时间。​
父节点:Tasks​
StartTime​
String​
2025-05-19T16:31:29+08:00​
工作流模版执行开始时间。​
父节点:Tasks​
EndTime​
String​
2025-05-19T16:31:30+08:00​
工作流模版执行结束时间。​
父节点:Tasks​
Code​
String​
0​
错误码。​
父节点:Tasks​
Message​
String​
-​
错误信息。​
父节点:Tasks​
NextPageToken​
String​
-​
下一页数据的位置。​
​
请求示例​
​
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​
​
响应示例​
​
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": ""​
}​
​
​
最近更新时间:2026.01.21 16:38:43
这个页面对您有帮助吗?
有用
有用
无用
无用