文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑API（不包含安全分析V2）/ 流程实例管理/ 查询流程实例的列表 - ListAopWorkflowInstance
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询流程实例的列表 - ListAopWorkflowInstance

功能介绍

查询流程实例的列表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/workflows/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释:

工作空间ID

取值范围:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量

约束限制：

0-10000

取值范围：

不涉及

默认取值：

0

limit

否

Integer

参数解释：

数据量

约束限制：

1-100

取值范围：

不涉及

默认取值：

10

sort_key

否

String

参数解释：

排序字段，

  • create_time：创建时间

  • update_time：更新时间

约束限制：

不涉及

取值范围：

  • create_time

  • update_time

默认取值：

create_time

sort_dir

否

String

参数解释：

排序顺序

  • ASC：升序

  • DESC：降序

约束限制：

不涉及

取值范围：

  • ASC：升序

  • DESC：降序

默认取值：

DESC

from_date

否

String

参数解释:

开始时间

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

to_date

否

String

参数解释:

截止时间

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

workflow_id

否

String

参数解释:

流程的ID

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

id

否

String

参数解释:

实例的ID

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

name

否

String

参数解释:

实例的名字

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

dataobject_id

否

String

参数解释:

触发流程对象的id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

dataclass_id

否

String

参数解释:

数据类的ID

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

playbook_id

否

String

参数解释:

剧本ID

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

defence_id

否

String

参数解释:

防线ID

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

status

否

String

参数解释:

流程实例的状态

  • RUNNING 运行中

  • FAILED 运行失败

  • FINISHED 运行结束

  • RETRYING 重试中

  • TERMINATING 终止中

  • TERMINATED 已终止

约束限制:

不涉及

取值范围:

  • RUNNING

  • FAILED

  • FINISHED

  • RETRYING

  • TERMINATING

  • TERMINATED

默认值:

不涉及

trigger_type

否

String

参数解释:

触发方式

  • DEBUG 调试触发

  • TIMER 定时触发

  • EVENT 事件触发

  • MANUAL 手动触发

约束限制:

不涉及

取值范围:

  • DEBUG

  • TIMER

  • EVENT

  • MANUAL

默认值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content-type

是

String

参数解释：

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制：

不涉及

取值范围：

  • application/json;charset=UTF-8

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释:

流程实例的个数

约束限制:

不涉及

instances

Array of AopworkflowInstanceDetail objects

参数解释:

流程实例详情的列表

约束限制:

不涉及
表5 AopworkflowInstanceDetail

参数

参数类型

描述

id

String

参数解释:

流程实例的ID

约束限制:

不涉及

name

String

参数解释:

流程实例的名字

约束限制:

不涉及

workflow

workflow object

流程对象

dataclass

dataclass object

数据类对象

playbook

playbook object

剧本对象

trigger_type

String

参数解释:

触发方式

取值范围:

  • DEBUG 调试触发

  • TIMER 定时触发

  • EVENT 事件触发

  • MANUAL 手动触发

status

String

参数解释:

流程实例的状态

取值范围:

  • RUNNING 运行中

  • FAILED 运行失败

  • FINISHED 运行结束

  • RETRYING 重试中

  • TERMINATING 终止中

  • TERMINATED 已终止

start_time

String

参数解释:

开始时间

约束限制:

不涉及

end_time

String

参数解释:

结束时间

约束限制:

不涉及

retry_count

Integer

参数解释:

流程实例重试次数

约束限制:

不涉及

defense_id

String

参数解释:

防线ID

约束限制:

不涉及

dataobject_id

String

参数解释:

dataobject的ID

约束限制:

不涉及

topology

WorkflowInstanceTopology object

参数解释:

流程实例拓扑图信息

约束限制:

不涉及
表6 workflow

参数

参数类型

描述

id

String

参数解释:

流程的ID

约束限制:

不涉及

name

String

参数解释:

流程的中文名字

约束限制:

不涉及

name_en

String

参数解释:

流程的英文名字

约束限制:

不涉及

version

String

参数解释:

流程的版本

约束限制:

不涉及

version_id

String

参数解释:

流程的版本ID

约束限制:

不涉及
表7 dataclass

参数

参数类型

描述

en_name

String

参数解释:

数据类的英文名字

约束限制:

不涉及

id

String

参数解释:

数据类的ID

约束限制:

不涉及

name

String

参数解释:

数据类的中文名字

约束限制:

不涉及
表8 playbook

参数

参数类型

描述

en_name

String

参数解释:

剧本英文名字

约束限制:

不涉及

id

String

参数解释:

剧本的ID

约束限制:

不涉及

name

String

参数解释:

剧本的名字

约束限制:

不涉及
表9 WorkflowInstanceTopology

参数

参数类型

描述

audit_logs

Array of TopologyNodeInfo objects

参数解释:

拓扑图节点信息

约束限制:

不涉及
表10 TopologyNodeInfo

参数

参数类型

描述

instance_type

String

参数解释:

流程图拓扑图的节点实例类型

取值范围:

  • TASK

action_id

String

参数解释:

流程拓扑图的节点ID

取值范围:

不涉及

action_name

String

参数解释:

流程拓扑图的节点名称

取值范围:

不涉及

start_time

String

参数解释:

流程图拓扑图的节点开始时间

取值范围:

  • 不涉及

end_time

String

参数解释:

流程图拓扑图的节点结束时间

取值范围:

  • 不涉及

error_msg

String

参数解释:

流程图拓扑图的节点错误信息

取值范围:

  • 不涉及

input

String

参数解释:

流程图拓扑图的节点输入信息

取值范围:

  • 不涉及

output

String

参数解释:

流程图拓扑图的节点输出信息

取值范围:

  • 不涉及

parent_instance_id

String

参数解释:

流程图拓扑图的父实例ID

取值范围:

  • 不涉及

status

String

参数解释:

流程图拓扑图的节点的状态

取值范围:

  • RUNNING 运行中

  • FAILED 运行失败

  • FINISHED 运行结束

succeed

Boolean

参数解释:

流程图拓扑图的节点是否成功

取值范围:

  • true 成功

  • false 失败

状态码：400

表11 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

查询名字为ZFGJZDGB-20250718151103的实例列表

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/workflows/instances?limit=10&offset=0&name=ZFGJZDGB-20250718151103

响应示例

状态码：200

查询流程实例列表的响应

{
  "count" : 1,
  "instances" : [ {
    "dataclass" : {
      "id" : "e410ae50-43fa-343e-807a-a2a9edb8018e",
      "name" : "Alert"
    },
    "dataobject_id" : "2462e8c3-e393-4af9-93b6-fe424c0b4e39",
    "defense_id" : "",
    "end_time" : "2025-07-18T15:11:04.577Z+0800",
    "id" : "8eed56de-7aaf-4732-baaf-46c1bb11dc8f",
    "name" : "ZFGJZDGB-20250718151103",
    "playbook" : {
      "id" : "3e966553-f53d-3d87-835e-7697e353876a",
      "name" : "Automatic closing of repeated alerts"
    },
    "retry_count" : 0,
    "start_time" : "2025-07-18T15:11:03.000Z+0800",
    "status" : "FINISHED",
    "trigger_type" : "EVENT",
    "workflow" : {
      "id" : "4a6fe02f-b4b4-3b5f-8a11-6f22229e18db",
      "name" : "Automatic closing of repeated alerts",
      "version" : "v1",
      "version_id" : "9f436a38-5c82-312b-aaba-b91a48e99086"
    }
  } ]
}

状态码

状态码

描述

200

查询流程实例列表的响应

400

异常的响应

错误码

请参见错误码。

父主题： 流程实例管理

相关文档