REST API V2

GET /v2/tasks¶

返回指定的任务。

参数：

id (str) – 要检索的任务的 UUID
fields (uniquelist) – 可选。要返回的资源的指定字段列表。如果未提供，‘id’ 将自动包含在字段中。

返回类型:

PUT /v2/tasks¶

更新指定的任务执行。

参数：

id (str) – 任务执行 ID。
task (Task) – 任务执行对象。

返回类型:

GET /v2/executions¶

返回执行中的所有任务。

其中 project_id 与请求者相同，或者 project_id 不同但范围是公开的。

参数：

marker (uuid) – 可选。用于大型数据集的分页标记。
limit (int) – 可选。每次结果中返回的最大资源数量。默认值为 None，以保持向后兼容性。
sort_keys (uniquelist) – 可选。用于排序结果的列。默认值：created_at，与旧版本兼容。
sort_dirs (list) – 可选。对应于 sort_keys 的排序方向，可以选择“asc”或“desc”。默认值：desc。sort_dirs 的长度可以等于或小于 sort_keys 的长度。
fields (uniquelist) – 可选。要返回的资源的指定字段列表。如果未提供，‘id’ 将自动包含在字段中，因为它将在构造 ‘next’ 链接时使用。
name (str) – 可选。仅保留具有特定名称的资源。
workflow_name (str) – 可选。仅保留具有特定工作流名称的资源。
workflow_id (uuid) – 可选。仅保留具有特定工作流 ID 的资源。
workflow_execution_id (uuid) – 可选。仅保留具有特定工作流执行 ID 的资源。
tags (uniquelist) – 可选。仅保留包含特定标签的资源。
state (Enum(IDLE, RUNNING, SUCCESS, ERROR, DELAYED)) – 可选。仅保留具有特定状态的资源。
state_info (str) – 可选。仅保留具有特定状态信息的资源。
result (str) – 可选。仅保留具有特定结果的资源。
published (json) – 可选。仅保留具有特定已发布内容的资源。
processed (bool) – 可选。仅保留已处理或未处理的资源。
reset (bool) – 可选。仅保留已重置或未重置的资源。
env (json) – 可选。仅保留具有特定环境的资源。
created_at (str) – 可选。仅保留在特定时间和日期创建的资源。
updated_at (str) – 可选。仅保留具有特定最新更新时间和日期的资源。

返回类型:

Action Executions¶

当 Task 启动时，Mistral 会创建一组 Action Executions。因此，Action Execution 是 Workflow Task 中描述的 action 调用的一个实例，属于特定的执行。

type ActionExecution¶

ActionExecution 资源。

数据示例

Json

{
    "accepted": true,
    "created_at": "1970-01-01T00:00:00.000000",
    "description": "My running action",
    "id": "123e4567-e89b-12d3-a456-426655440000",
    "input": "{\"first_name\": \"John\", \"last_name\": \"Doe\"}",
    "name": "std.echo",
    "output": "{\"some_output\": \"Hello, John Doe!\"}",
    "params": "{\"save_result\": true, \"run_sync\": false}",
    "project_id": "40a908dbddfe48ad80a87fb30fa70a03",
    "state": "SUCCESS",
    "state_info": "SUCCESS",
    "tags": [
        "foo",
        "fee"
    ],
    "task_execution_id": "343e45623-e89b-12d3-a456-426655440090",
    "task_name": "task1",
    "updated_at": "1970-01-01T00:00:00.000000",
    "workflow_name": "flow"
}

type ActionExecutions¶

action_executions 集合。

数据示例

Json

{
    "action_executions": [
        {
            "accepted": true,
            "created_at": "1970-01-01T00:00:00.000000",
            "description": "My running action",
            "id": "123e4567-e89b-12d3-a456-426655440000",
            "input": "{\"first_name\": \"John\", \"last_name\": \"Doe\"}",
            "name": "std.echo",
            "output": "{\"some_output\": \"Hello, John Doe!\"}",
            "params": "{\"save_result\": true, \"run_sync\": false}",
            "project_id": "40a908dbddfe48ad80a87fb30fa70a03",
            "state": "SUCCESS",
            "state_info": "SUCCESS",
            "tags": [
                "foo",
                "fee"
            ],
            "task_execution_id": "343e45623-e89b-12d3-a456-426655440090",
            "task_name": "task1",
            "updated_at": "1970-01-01T00:00:00.000000",
            "workflow_name": "flow"
        }
    ]
}

next¶

类型:: str

一个链接，用于检索资源列表的下一个子集

GET /v2/action_executions¶

返回执行中的所有任务。

其中 project_id 与请求者相同，或者 project_id 不同但范围是公开的。

参数：

marker (uuid) – 可选。用于大型数据集的分页标记。
limit (int) – 可选。每次结果中返回的最大资源数量。默认值为 None，以保持向后兼容性。
sort_keys (uniquelist) – 可选。用于排序结果的列。默认值：created_at，与旧版本兼容。
sort_dirs (list) – 可选。对应于 sort_keys 的排序方向，可以选择“asc”或“desc”。默认值：desc。sort_dirs 的长度可以等于或小于 sort_keys 的长度。
fields (uniquelist) – 可选。要返回的资源的指定字段列表。如果未提供，‘id’ 将自动包含在字段中，因为它将在构造 ‘next’ 链接时使用。
name (str) – 可选。仅保留具有特定名称的资源。
workflow_name (str) – 可选。仅保留具有特定工作流名称的资源。
task_name (str) – 可选。仅保留具有特定任务名称的资源。
task_execution_id (uuid) – 可选。仅保留特定任务执行中的资源。
state (str) – 可选。仅保留具有特定状态的资源。
state_info (str) – 可选。仅保留具有特定状态信息的资源。
accepted (bool) – 可选。仅保留已接受或未接受的资源。
input (json) – 可选。仅保留具有特定输入的资源。
output (json) – 可选。仅保留具有特定输出的资源。
params (json) – 可选。仅保留具有特定参数的资源。
description (str) – 可选。仅保留具有特定 description 的资源。
tags (str) – 可选。仅保留包含特定标签的资源。
created_at (str) – 可选。仅保留在特定时间和日期创建的资源。
updated_at (str) – 可选。仅保留具有特定最新更新时间和日期的资源。
include_output (bool) – 可选。在列表中包含所有执行的输出

返回类型:

ActionExecutions

GET /v2/action_executions¶

返回指定的 action_execution。

参数：

id (str) – 要检索的 action execution 的 UUID
fields (uniquelist) – 可选。要返回的资源的指定字段列表。如果未提供，‘id’ 将自动包含在字段中。

返回类型:

POST /v2/action_executions¶

创建新的 action_execution。

参数：

action_ex (ActionExecution) – 要执行的 Action

返回类型:

PUT /v2/action_executions¶

更新指定的 action_execution。

参数：

id (str) – 要更新的 action execution 的 UUID
action_ex (ActionExecution) – 用于更新的 action execution

返回类型:

DELETE /v2/action_executions¶

删除指定的 action_execution。

参数：

id (str) – 要删除的 action execution 的 UUID

GET /v2/tasks¶

返回执行中的所有任务。

其中 project_id 与请求者相同，或者 project_id 不同但范围是公开的。

参数：

task_execution_id (uuid) – 仅保留特定任务执行中的资源。
marker (uuid) – 可选。用于大型数据集的分页标记。
limit (int) – 可选。每次结果中返回的最大资源数量。默认值为 None，以保持向后兼容性。
sort_keys (uniquelist) – 可选。用于排序结果的列。默认值：created_at，与旧版本兼容。
sort_dirs (list) – 可选。对应于 sort_keys 的排序方向，可以选择“asc”或“desc”。默认值：desc。sort_dirs 的长度可以等于或小于 sort_keys 的长度。
fields (uniquelist) – 可选。要返回的资源的指定字段列表。如果未提供，‘id’ 将自动包含在字段中，因为它将在构造 ‘next’ 链接时使用。
name (uniquelist) – 可选。仅保留具有特定名称的资源。
workflow_name (str) – 可选。仅保留具有特定工作流名称的资源。
task_name (str) – 可选。仅保留具有特定任务名称的资源。
state (str) – 可选。仅保留具有特定状态的资源。
state_info (str) – 可选。仅保留具有特定状态信息的资源。
accepted (bool) – 可选。仅保留已接受或未接受的资源。
input (json) – 可选。仅保留具有特定输入的资源。
output (json) – 可选。仅保留具有特定输出的资源。
params (json) – 可选。仅保留具有特定参数的资源。
description (str) – 可选。仅保留具有特定 description 的资源。
tags (str) – 可选。仅保留包含特定标签的资源。
created_at (str) – 可选。仅保留在特定时间和日期创建的资源。
updated_at (str) – 可选。仅保留具有特定最新更新时间和日期的资源。
include_output (bool) – 可选。在列表中包含所有执行的输出

返回类型:

ActionExecutions

GET /v2/tasks¶

返回指定的 action_execution。

参数：

task_execution_id (str) – 任务执行 UUID
action_ex_id (str) – Action execution UUID
fields (uniquelist) – 可选。要返回的资源的指定字段列表。如果未提供，‘id’ 将自动包含在字段中。

返回类型:

Cron Triggers¶

Cron 触发器是一个对象，允许根据时间模式（Unix crontab 模式格式）运行 Mistral 工作流。创建触发器后，它将根据其属性运行指定的 workflow：pattern、first_execution_time 和 remaining_executions。

type CronTrigger¶

CronTrigger 资源。

数据示例

Json

{
    "created_at": "1970-01-01T00:00:00.000000",
    "id": "123e4567-e89b-12d3-a456-426655440000",
    "name": "my_trigger",
    "pattern": "* * * * *",
    "project_id": "40a908dbddfe48ad80a87fb30fa70a03",
    "remaining_executions": 42,
    "scope": "private",
    "updated_at": "1970-01-01T00:00:00.000000",
    "workflow_id": "123e4567-e89b-12d3-a456-426655441111",
    "workflow_input": "{}",
    "workflow_name": "my_wf",
    "workflow_params": "{}"
}

type CronTriggers¶

cron 触发器集合。

数据示例

Json

{
    "cron_triggers": [
        {
            "created_at": "1970-01-01T00:00:00.000000",
            "id": "123e4567-e89b-12d3-a456-426655440000",
            "name": "my_trigger",
            "pattern": "* * * * *",
            "project_id": "40a908dbddfe48ad80a87fb30fa70a03",
            "remaining_executions": 42,
            "scope": "private",
            "updated_at": "1970-01-01T00:00:00.000000",
            "workflow_id": "123e4567-e89b-12d3-a456-426655441111",
            "workflow_input": "{}",
            "workflow_name": "my_wf",
            "workflow_params": "{}"
        }
    ]
}

next¶

类型:: str

一个链接，用于检索资源列表的下一个子集

GET /v2/cron_triggers¶

返回所有 cron 触发器。

参数：

marker (uuid) – 可选。用于大型数据集的分页标记。
limit (int) – 可选。每次结果中返回的最大资源数量。默认值为 None，以保持向后兼容性。
sort_keys (uniquelist) – 可选。用于排序结果的列。默认值：created_at，与旧版本兼容。
sort_dirs (list) – 可选。对应于 sort_keys 的排序方向，可以选择“asc”或“desc”。默认值：desc。sort_dirs 的长度可以等于或小于 sort_keys 的长度。
fields (uniquelist) – 可选。要返回的资源的指定字段列表。如果未提供，‘id’ 将自动包含在字段中，因为它将在构造 ‘next’ 链接时使用。
name (str) – 可选。仅保留具有特定名称的资源。
workflow_name (str) – 可选。仅保留具有特定工作流名称的资源。
workflow_id (uuid) – 可选。仅保留具有特定工作流 ID 的资源。
workflow_input (json) – 可选。仅保留具有特定 workflow 输入的资源。
workflow_params (json) – 可选。仅保留具有特定 workflow 参数的资源。
scope (Enum(private, public)) – 可选。仅保留具有特定作用域的资源。
pattern (str) – 可选。仅保留具有特定模式的资源。
remaining_executions (integer) – 可选。仅保留具有特定剩余执行次数的资源。
project_id (uuid) – 可选。仅保留具有特定项目 ID 的资源。
first_execution_time (str) – 可选。仅保留具有特定首次执行时间和日期的资源。
next_execution_time (str) – 可选。仅保留具有特定下次执行时间和日期的资源。
created_at (str) – 可选。仅保留在特定时间和日期创建的资源。
updated_at (str) – 可选。仅保留具有特定最新更新时间和日期的资源。
all_projects (bool) – 可选。获取所有项目的资源。

返回类型:

CronTriggers

GET /v2/cron_triggers¶

返回指定的 cron_trigger。

参数：

identifier (str) – cron 触发器的 ID 或名称，用于检索
fields (uniquelist) – 可选。要返回的资源的指定字段列表。如果未提供，‘id’ 将自动包含在字段中。

返回类型:

CronTrigger

POST /v2/cron_triggers¶

创建一个新的 cron 触发器。

参数：

cron_trigger (CronTrigger) – 必需。Cron 触发器结构。

返回类型:

CronTrigger

DELETE /v2/cron_triggers¶

删除 cron 触发器。

参数：

identifier (str) – 要删除的 cron 触发器的 ID 或名称

Environments¶

Environment 包含一组可以在特定 workflow 中使用的变量。使用 Environment 可以创建和映射 action 的默认值 - 只需要在 ‘variables’ 中提供 ‘__actions’ 键。所有这些变量都可以使用 Workflow Language 通过 <% $.__env %> 表达式访问。

用例示例

workflow:
  tasks:
    task1:
      action: std.echo output=<% $.__env.my_echo_output %>

创建 action 默认值的示例

...ENV...
"variables": {
  "__actions": {
    "std.echo": {
      "output": "my_output"
    }
  }
},
...ENV...

注意：使用 CLI 时，Environment 可以通过 JSON 或 YAML 文件创建。

type Environment¶

Environment 资源。

数据示例

Json

{
    "created_at": "1970-01-01T00:00:00.000000",
    "description": "example environment entry",
    "id": "123e4567-e89b-12d3-a456-426655440000",
    "name": "sample",
    "project_id": "40a908dbddfe48ad80a87fb30fa70a03",
    "scope": "private",
    "updated_at": "1970-01-01T00:00:00.000000",
    "variables": "{\"server\": \"localhost\", \"database\": \"temp\", \"timeout\": 600, \"verbose\": true}"
}

type Environments¶

Environment 资源的集合。

数据示例

Json

{
    "environments": [
        {
            "created_at": "1970-01-01T00:00:00.000000",
            "description": "example environment entry",
            "id": "123e4567-e89b-12d3-a456-426655440000",
            "name": "sample",
            "project_id": "40a908dbddfe48ad80a87fb30fa70a03",
            "scope": "private",
            "updated_at": "1970-01-01T00:00:00.000000",
            "variables": "{\"server\": \"localhost\", \"database\": \"temp\", \"timeout\": 600, \"verbose\": true}"
        }
    ]
}

next¶

类型:: str

一个链接，用于检索资源列表的下一个子集

GET /v2/environments¶

返回所有 environments。

其中 project_id 与请求者相同，或者 project_id 不同但范围是公开的。

参数：

marker (uuid) – 可选。用于大型数据集的分页标记。
limit (int) – 可选。每次结果中返回的最大资源数量。默认值为 None，以保持向后兼容性。
sort_keys (uniquelist) – 可选。用于排序结果的列。默认值：created_at，与旧版本兼容。
sort_dirs (list) – 可选。对应于 sort_keys 的排序方向，可以选择“asc”或“desc”。默认值：desc。sort_dirs 的长度可以等于或小于 sort_keys 的长度。
fields (uniquelist) – 可选。要返回的资源的指定字段列表。如果未提供，‘id’ 将自动包含在字段中，因为它将在构造 ‘next’ 链接时使用。
name (str) – 可选。仅保留具有特定名称的资源。
description (str) – 可选。仅保留具有特定 description 的资源。
variables (json) – 可选。仅保留具有特定变量的资源。
scope (Enum(private, public)) – 可选。仅保留具有特定作用域的资源。
created_at (str) – 可选。仅保留在特定时间和日期创建的资源。
updated_at (str) – 可选。仅保留具有特定最新更新时间和日期的资源。

返回类型:

GET /v2/environments¶

返回指定的 environment。

参数：

name (str) – 要检索的 environment 的名称
fields (uniquelist) – 可选。要返回的资源的指定字段列表。如果未提供，‘id’ 将自动包含在字段中。

返回类型:

POST /v2/environments¶

创建一个新的 environment。

参数：

env (Environment) – 必需。要创建的 Environment 结构

返回类型:

PUT /v2/environments¶

更新一个 environment。

参数：

env (Environment) – 必需。要更新的 Environment 结构

返回类型: