功能描述
获取工作流实例列表。
授权说明
服务开通
注意:
数据万象绑定后,如果您手动对存储桶进行数据万象的解绑操作,将无法继续使用该功能。
使用限制
请求
请求示例
GET /workflowexecution HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml
说明:
请求头
请求体
该请求的请求体为空。
请求参数
参数名称(关键字) | 描述 | 类型 | 是否必选 |
workflowId | String | 否 | |
name | 文件名称 | String | 否 |
orderByTime | Desc 或者 Asc。默认为 Desc | String | 否 |
size | 拉取的最大任务数。默认为10。最大为100 | String | 否 |
states | 工作流实例状态,以 , 分隔支持多状态Running:执行中 Success:执行成功 Failed:执行失败 Pause:任务暂停,当暂停队列时,待执行的任务会变为暂停状态 Cancel:任务被取消执行 默认为 All(全部) | String | 否 |
startCreationTime | 拉取创建时间大于等于该时间。格式为: %Y-%m-%dT%H:%m:%S%z | String | 否 |
endCreationTime | 拉取创建时间小于等于该时间。格式为: %Y-%m-%dT%H:%m:%S%z | String | 否 |
nextToken | 请求的上下文,用于翻页。下一页输入 token | String | 否 |
jobId | 批量触发工作流任务 ID,用于扫描出批量触发任务 ID 对应执行的工作流实例 | String | 否 |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<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>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
WorkflowExecutionList | Response | 工作流实例详细信息 | Container |
RequestId | Response | 请求 ID | String |
NextToken | Response | 翻页的上下文 Token | String |
Container 节点 WorkflowExecutionList 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
RunId | Response.WorkflowExecutionList | 工作流实例 ID | String |
WorkflowId | Response.WorkflowExecutionList | 工作流 ID | String |
State | Response.WorkflowExecutionList | 工作流实例状态 | String |
CreateTime | Response.WorkflowExecutionList | 创建时间 | String |
Object | Response.WorkflowExecutionList | COS 对象地址 | String |
错误码
实际案例
请求
GET /workflowexecution?workflowId=web6ac56c1ef54dbfa44d7f4103203be9 HTTP/1.1Authorization: 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
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 666Connection: keep-aliveDate: Thu, 09 Aug 2022 16:23:12 GMTServer: tencent-cix-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>