- 文档首页
AI 数据湖服务
API 参考:管控面
工作流模板
ListWorkflows - 获取工作流列表
工作流模板
ListWorkflows - 获取工作流列表
ListWorkflows - 获取工作流列表
获取工作流列表
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。 Action string 必选 示例值:ListWorkflows
要执行的操作,取值:ListWorkflows。
Version string 必选 示例值:2025-08-15
API的版本,取值:2025-08-15。
Name string 可选 示例值:workflow_name
工作流名
SortBy string 可选 示例值:CreateTime
排序字段, CreateTime
OwnerIds long[] 可选 示例值:[ 123, 456 ]
子账号(创建者) Id 列表
NextToken string 可选 示例值:nextToken
下一次查询起始Id(不包含)或页码(默认为0)
SortOrder string 可选 示例值:Asc
SortOrder
MaxResults integer 可选 示例值:10
单页记录数
ClientToken string 可选 示例值:uuid-xxxxxx
客户端token
WorkflowIds string[] 可选 示例值:[ "workflowId1", "workflowId2" ]
工作流 Id 数组
返回参数
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。 Items object[] 示例值:[]
概要列表
Name string 示例值:workflow_name
工作流名称
Content string 示例值:apiVersion: argoproj.io/v1alpha1 kind: Workflow metadata: generateName: las-task- spec: entrypoint: main templates: - name: main dag: tasks: - name: las-task templateRef: name: las-system-template template: las-task clusterScope: true arguments: parameters: - name: task_id value: "Ray-xxx" - name: task_resources value: '{"QueueResourceId":"PUBLIC_resource_xxx","RayParams":{"WorkerCpu":1,"WorkerMemory":8,"WorkerGpuNum":1,"HeadCpu":1,"HeadMemory":4}}'
工作流内容,使用argo yaml编排
OwnerId string 示例值:12345678
子账号 id
AccountId string 示例值:2000000001
主账号 id
CreateTime string 示例值:2025-08-15T10:00:00Z
创建时间
UpdateTime string 示例值:2025-08-15T10:00:00Z
更新时间
WorkflowId string 示例值:wf-tpl-ea241ccb342e79e995c6
工作流id
Description string 示例值:description
工作流描述
SchedulerId string 示例值:s-12345678
定时任务 ID
NextToken string 示例值:0
分页查询的下一页token
MaxResults integer 示例值:10
单次查询可返回的最大记录数
TotalCount long 示例值:100
总记录数
请求示例
POST https://open.volcengineapi.com
"Name": "workflow_name",
"NextToken": "nextToken",
"WorkflowId": "wf-tpl-xxx"
返回示例
"Action": "ListWorkflows",
"Version": "2025-08-15",
"RequestId": "20230604110420****100232280022D31",
"WorkflowId": "wf-tpl-xxx",
"Name": "workflow_name",
"AccountId": "2000000001",
"Content": "apiVersion: argoproj.io/v1alpha1\nkind: Workflow\nmetadata:\n generateName: las-task-\nspec:\n entrypoint: main\n templates:\n - name: main\n dag:\n tasks:\n - name: las-task\n templateRef:\n name: las-system-template\n template: las-task\n clusterScope: true\n arguments:\n parameters:\n - name: task_id\n value: \"Ray-xxx\"\n - name: task_resources\n value: '{\"QueueResourceId\":\"PUBLIC_resource_xxx\",\"RayParams\":{\"WorkerCpu\":1,\"WorkerMemory\":8,\"WorkerGpuNum\":1,\"HeadCpu\":1,\"HeadMemory\":4}}'",
"Description": "description",
"SchedulerId": "s-12345678",
"CreateTime": "2025-08-15T10:00:00Z",
"UpdateTime": "2025-08-15T10:00:00Z"
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
最近更新时间:2026.08.18 11:54:15