启用工作流

将已停用(disabled)的工作流切换为就绪(ready)状态,并重新激活其已配置的定时调度或数据卷触发入口。已暂停(paused)的工作流需调用恢复工作流连同被工作流暂停的运行一起恢复;调用本接口不会立即新建一次作业运行。

POST https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/{workflow_id}/enable

调用前准备

  1. 准备具有工作流启用权限的个人访问令牌和目标工作区 ID。

  2. 先调用查询工作流详情,确认目标工作流 ID,且当前 status 为 disabled、source_type 不为 agent_automation_task。

请求参数

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $WORKFLOW_ID 替换为实际值。

curl -X POST "https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/$WORKFLOW_ID/enable" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

路径参数

参数

类型

是否必填

说明

workflow_id

string

是

要启用的工作流 ID,可从查询工作流列表取得。

成功响应

返回 HTTP 200 及启用后的工作流详情。若目标工作流已处于 ready 状态,直接返回当前工作流详情。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workflow": {
      "id": "wf-001",
      "name": "daily-import",
      "description": "导入每日文件",
      "source_type": "manual_dsl",
      "status": "ready",
      "available_actions": [
        "update",
        "delete",
        "run",
        "pause",
        "list_executions"
      ],
      "execution_mode": "cron",
      "cron_expression": "0 2 * * *",
      "latest_workflow_version_id": "ver-001",
      "execution_summary": {
        "total_executions": 8,
        "active_executions": 0
      },
      "trigger_summary": {
        "mode": "cron",
        "configured": true,
        "enabled": true,
        "cron_expression": "0 2 * * *"
      },
      "created_at": "2026-10-14T00:00:00Z",
      "updated_at": "2026-10-14T08:30:00Z",
      "dsl_yaml": "workflow:\n  name: daily-import\n  root: main\nroot:\n  chain: []\n",
      "definition_format": "dsl",
      "moi_workflow_def_id": "def-001"
    }
  }
}

字段

类型

说明

code

string

请求处理成功时为 OK。

msg

string

请求处理结果说明,成功时为 OK。

data

object

本次操作返回的数据。

data.workflow

object

启用后的工作流详情对象。

data.workflow.automation_task_id

string

关联的智能体自动化任务 ID;仅关联时返回。

data.workflow.session_id

string

关联的编写会话 ID;服务端提供时返回。

data.workflow.id

string

工作流 ID。

data.workflow.name

string

工作流名称。

data.workflow.description

string

工作流说明;设置后返回。

data.workflow.source_type

string

工作流来源类型,取值为 nl2dsl、manual_dsl、manual_mowl、system 或 agent_automation_task。

data.workflow.status

string

启用后的工作流状态,成功启用后为 ready(完整枚举为 ready、disabled、paused)。

data.workflow.available_actions

array of string

按当前状态派生的可执行动作提示(取值为 update、delete、enable、resume、run、pause、list_executions),不代表已通过当前身份的权限检查。

data.workflow.execution_mode

string

已配置的运行方式,取值为 one_shot、volume_trigger、cron、dynamic_service 或 task_by_version。

data.workflow.cron_expression

string

定时调度的 Cron 表达式;仅配置定时调度时返回。

data.workflow.draft_id

string

关联的草稿 ID;服务端提供时返回。

data.workflow.candidate_id

string

关联的候选方案 ID;服务端提供时返回。

data.workflow.latest_workflow_version_id

string

最新工作流版本 ID;已生成版本时返回。

data.workflow.compute_resource_id

string

工作流级计算资源 ID;已绑定时返回。

data.workflow.compute_resource_bindings

array of object

工作流级或节点级计算资源绑定列表;已绑定时返回。

data.workflow.compute_resource_bindings[].id

string

计算资源 ID。

data.workflow.compute_resource_bindings[].name

string

计算资源名称;服务端提供时返回。

data.workflow.compute_resource_bindings[].workflow_level

boolean

是否为工作流级绑定。

data.workflow.compute_resource_bindings[].node_names

array of string

使用该计算资源的节点名称列表。

data.workflow.execution_summary

object

作业运行统计摘要。

data.workflow.execution_summary.total_executions

integer

历史作业总数。

data.workflow.execution_summary.active_executions

integer

当前活动作业数。

data.workflow.execution_summary.active_execution_id

string

当前活动作业 ID;存在活动作业时返回。

data.workflow.execution_summary.active_execution_status

string

当前活动作业状态;存在活动作业时返回。

data.workflow.execution_summary.latest_execution_id

string

最近一次作业 ID;存在历史作业时返回。

data.workflow.execution_summary.latest_execution_status

string

最近一次作业状态;存在历史作业时返回。

data.workflow.execution_summary.latest_execution_at

string

最近一次作业时间;存在历史作业时返回。

data.workflow.trigger_summary

object

触发配置摘要。

data.workflow.trigger_summary.mode

string

触发运行模式,取值为 one_shot、volume_trigger、cron、dynamic_service 或 task_by_version。

data.workflow.trigger_summary.configured

boolean

是否已完成触发配置。

data.workflow.trigger_summary.enabled

boolean

触发器当前是否处于启用状态。

data.workflow.trigger_summary.volume_id

integer

数据卷触发绑定的数据卷 ID;仅数据卷触发时返回。

data.workflow.trigger_summary.cron_expression

string

定时触发的 Cron 表达式;仅定时触发时返回。

data.workflow.trigger_summary.service_name

string

动态 API 服务名称;仅动态服务模式返回。

data.workflow.trigger_summary.input_schema

string

动态服务最新版本的输入 Schema JSON 字符串;存在时返回。

data.workflow.trigger_summary.output_schema

string

动态服务最新版本的输出 Schema JSON 字符串;存在时返回。

data.workflow.created_at

string

创建时间,采用 RFC 3339 格式。

data.workflow.updated_at

string

最近更新时间,采用 RFC 3339 格式。

data.workflow.goal

string

工作流目标说明;服务端提供时返回。

data.workflow.planner_model

string

规划模型名称;服务端提供时返回。

data.workflow.dsl_yaml

string

工作流 DSL 文本。

data.workflow.workflow

object

原生 MOWL 工作流定义对象;按原生定义保存时返回。

data.workflow.definition_format

string

定义格式,取值为 dsl、mowl 或空字符串 ""。

data.workflow.run_context

object

运行上下文对象;服务端提供时返回。

data.workflow.runtime_fields

object

运行输入表单定义;已配置时返回,子字段结构与查询工作流详情一致。

data.workflow.runtime_layout

object

运行输入表单布局;已配置时返回,子字段结构与查询工作流详情一致。

data.workflow.default_values

object

默认运行参数对象;已配置时返回。

data.workflow.design_graph

object

工作流设计图对象;已配置时返回。

data.workflow.notification_config

object

作业终态通知配置对象;已配置时返回。

data.workflow.moi_workflow_def_id

string

关联的工作流定义 ID;存在时返回。

data.workflow.ui_resource

object

动态服务绑定的交互页面资源;仅绑定时返回。

data.workflow.ui_resource.resource_uri

string

派生的服务页面资源 URI。

data.workflow.ui_resource.file_id

string

工作区 HTML 文件 ID。

data.workflow.ui_resource.mime_type

string

资源 MIME 类型,固定为 text/html。

错误响应

工作流不存在返回 404(ErrNotFound);工作流由智能体自动化任务托管(source_type 为 agent_automation_task)或运行身份版本失效时返回 409;对处于 paused 状态的工作流调用本接口会因状态前置条件不满足而失败,请改调恢复工作流。

{
  "code": "ErrWorkflowUpdateManagedByAutomation",
  "msg": "工作流由自动化任务托管,请编辑对应的自动化任务"
}

字段

类型

说明

code

string

错误代码,例如 ErrWorkspaceRequired、ErrForbidden、ErrNotFound、ErrWorkflowUpdateManagedByAutomation 或 ErrServer。

msg

string

可读错误信息。

最后更新于