You need to enable JavaScript to run this app.
文档中心
AI 数据湖服务

AI 数据湖服务

复制全文
下载 pdf
工作流实例
ListWorkflowInstances - 获取工作流实例列表
复制全文
下载 pdf
ListWorkflowInstances - 获取工作流实例列表
获取工作流实例列表​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ListWorkflowInstances​
要执行的操作,取值:ListWorkflowInstances。​
​
Version string 必选 示例值:2025-08-15​
API的版本,取值:2025-08-15。​
​
SortBy string 可选 示例值:StartTime​
SortBy​
​
Statuses string[] 可选 示例值:[ "Running", "Succeeded" ]​
工作流实例状态列表​
​
NextToken string 可选 示例值:nextToken​
下一次查询起始Id(不包含)或页码(默认为0)​
​
SortOrder string 可选 示例值:Desc​
SortOrder​
​
MaxResults integer 可选 示例值:10​
单页记录数​
​
ClientToken string 可选 示例值:uuid-xxxxxx​
客户端token​
​
WorkflowIds string[] 可选 示例值:[ "wf-tpl-xxx" ]​
工作流模板 Id 列表​
​
TriggerTypes string[] 可选 示例值:[ "Manual", "Cron" ]​
触发类型列表​
​
WorkflowInstanceIds string[] 可选 示例值:[ "wf-tpl-xxx-xxx" ]​
工作流实例 Id 列表​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Items object[] 示例值:[]​
概要列表​
Name string 示例值:workflow_instance_name​
工作流实例名称​
​
Status string 示例值:Running​
工作流实例状态​
​
EndTime string 示例值:2025-08-15T10:00:00Z​
任务结束时间​
​
RunEnvs object[] 示例值:[ { "Name": "n1", "Value": "v1" } ]​
作业运行环境变量​
Name string 示例值:Key​
Name​
​
Value string 示例值:Value​
Value​
​
​
AccountId string 示例值:2000000001​
主账号 id​
​
StartTime string 示例值:2025-08-15T10:00:00Z​
任务开始时间​
​
Permission string 示例值:Admin​
当前用户对工作流模板的权限角色​
​
RunOwnerId long 示例值:123456​
执行者子账号 Id​
​
UpdateTime string 示例值:2025-08-15T10:00:00Z​
任务更新时间​
​
WorkflowId string 示例值:wf-tpl-uuid​
工作流 Id​
​
ExecuteMode string 示例值:Normal​
工作流执行模式。Normal(默认)/HighConcurrency(高并发、节约资源)。HighConcurrency 模式下不再支持节点自动重试和从失败节点重试。​
​
TriggerType string​
TriggerType​
​
RunOwnerName string 示例值:name​
执行者子账号 Name​
​
WorkflowInstanceId string 示例值:wf-tpl-ea241ccb342e79e995c6-k8cnc​
工作流实例id​
​
​
NextToken string 示例值:0​
分页查询的下一页token​
​
MaxResults integer 示例值:10​
单次查询可返回的最大记录数​
​
TotalCount long 示例值:100​
总记录数​
​
​
​
请求示例​
​
POST https://open.volcengineapi.com​
{​
"SortBy": "StartTime",​
"Statuses": [​
"Running",​
"Succeeded"​
],​
"NextToken": "nextToken",​
"SortOrder": "Desc",​
"MaxResults": 10,​
"WorkflowId": "wf-tpl-xxx",​
"TriggerTypes": [​
"Manual",​
"Cron"​
]​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"Action": "ListWorkflowInstances",​
"Region": "cn-beijing",​
"Service": "las",​
"Version": "2025-08-15",​
"RequestId": "20230604110420****100232280022D31",​
"Deprecated": true​
},​
"Result": {​
"Items": [​
{​
"WorkflowInstanceId": "wf-tpl-xxx",​
"Name": "workflow_instance_name",​
"Status": "Running",​
"StartTime": "2025-08-15T10:00:00Z",​
"UpdateTime": "2025-08-15T10:00:00Z",​
"EndTime": "2025-08-15T10:00:00Z"​
}​
],​
"TotalCount": 1,​
"NextToken": "0",​
"MaxResults": 10​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
The specified parameter {} is invalid.​
指定的参数 {} 无效。​
400​
DryRunOperation​
The request is validated by a dryrun operation.​
该请求通过 dryrun 操作进行验证。​
400​
InvalidRequestParam​
Invalid request param {}, cause {}​
非法请求参数 {}, 原因 {}​
400​
MissingParameter​
The required parameter {} is missing.​
缺少必需的参数 {}。​
500​
InternalError​
The request has failed due to an unknown error.​
由于未知错误,请求失败。​
​
​
最近更新时间:2026.10.15 20:22:01
这个页面对您有帮助吗?
有用
有用
无用
无用