工作流

详情

获取工作流列表。

参数

无。

返回值

一个字典，包含以下键值对：

• total：整型标量，表示工作流总数。

• items：表，表示工作流列表。包含以下字段：

  字段名	类型	说明
  workflow_id	UUID	工作流的唯一 id
  workflow_name	STRING	工作流名称
  update_time	STRING	工作流的更新时间
  comment	STRING	工作流的备注
  run_record_count	INT	工作流的运行次数

例子

starfish::facplfBasic::facplf_get_workflow_list()

/ * output: 
total->1
items->
workflow_id	                         workflow_name update_time	           comment run_record_count
------------------------------------ ------------- ----------------------- ------- ----------------
b744b561-f15e-7936-7608-d98f420d9dd7 日常上线因子	   2024.11.04 11:39:48.837		   1
*/

详情

运行工作流。在使用前，需要先运行 use starfish::facplfRun。

参数

param：字典，键的类型为字符串。包含以下键值对：

• workflow_id：必填，STRING，要运行的工作流的唯一 ID。

返回值

无。

例子

use starfish::facplfRun
starfish::facplfRun::facplf_workflow_run({
  "workflow_id": "f245b916-973b-cece-d65f-70ca077fb02c
"})

详情

获取工作流记录详情。

参数

param：字典，键的类型为字符串。包含以下键值对：

• run_id：必填，STRING，要运行的工作流的唯一 ID。

返回值

一个字典，包含以下键值对：

• info：DICT，工作流信息，包含以下键值对：

  • workflow_name：STRING，工作流名称。

  • update_time：TIMESTAMP，最近更新时间。

  • comment：STRING，工作流备注。

  • creator：STRING，创建者名称。

• items：ANY VECTOR，工作流运行结果列表，每个元素为一个字典，以下键值对：

  • task_name：STRING，任务名称。

  • task_id：STRING，任务 ID。

  • job_type：INT，作业类型（枚举类型，例如：1 表示某类型）。

  • start_time：TIMESTAMP，任务开始时间。

  • run_node：STRING，运行任务的节点名称。

  • status：INT，任务状态，0 表示未完成，1 表示成功，-1 表示失败。

  • failed_reason：STRING，任务失败原因，若任务成功或未完成则返回空字符串。

• total：INT，工作流运行结果的总条数。

例子

starfish::facplfBasic::facplf_get_workflow_run_detail({"run_id": "admin_f245b916_973b_cece_d65f_70ca077fb02c_20241028T165428975"})

/* output:
{
  "info": {
    "workflow_name": "apitest_workflow",
    "update_time": "2024.10.28T16:54:20.428",
    "comment": "",
    "creator": "admin"
  },
  "items": [
    {
      "task_name": "apitest_task",
      "task_id": "311fc710-a592-6ba9-bd3a-77e0677309a1",
      "job_type": 1,
      "start_time": "2024.10.28T16:54:29.004",
      "run_node": "single7301",
      "status": 1,
      "failed_reason": ""
    }
  ],
  "total": 1
}
*/