ListWorkflowInstances - 获取工作流实例列表--AI 数据湖服务-火山引擎

文档中心

导航

ListWorkflowInstances - 获取工作流实例列表

最近更新时间：2025.11.12 15:08:20首次发布时间：2025.11.12 15:08:20

获取工作流实例列表

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListWorkflowInstances	要执行的操作，取值：ListWorkflowInstances。
Version	String	是	2025-08-15	API的版本，取值：2025-08-15。
SortBy	String	否	StartTime	排序字段, StartTime \| UpdateTime
Statuses	Array of String	否	Running,Succeeded	工作流实例状态
NextToken	String	否	nextToken	下一次查询起始Id（不包含）或页码（默认为0）
SortOrder	String	否	Desc	排序顺序, Asc \| Desc
MaxResults	Integer	否	10	单页记录数
WorkflowId	String	否	wf-tpl-xxx	工作流id
TriggerTypes	Array of String	否	Manual,Cron	触发类型

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Items	Array of Object	[ { "WorkflowInstanceId": "wf-xxx", "Name": "xxx", "Status": "Success", "StartTime": "2025-08-10T09:02:33Z", "UpdateTime": "2025-08-10T09:54:00Z", "EndTime": "2025-08-10T09:54:00Z", "RunEnvs": [ ] } ]	概要列表
NextToken	String	0	分页查询的下一页token
MaxResults	Integer	10	单次查询可返回的最大记录数
TotalCount	Long	0	总记录数

请求示例

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	DryRunOperation	The request is validated by a dryrun operation.	该请求通过 dryrun 操作进行验证。
400	InvalidRequestParam	Invalid request param {}, cause {}	非法请求参数 {}, 原因 {}
400	InvalidParameter	The specified parameter {} is invalid.	指定的参数 {} 无效。
400	MissingParameter	The required parameter {} is missing.	缺少必需的参数 {}。
500	InternalError	The request has failed due to an unknown error.	由于未知错误，请求失败。