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

查询流程详情 - ShowAopWorkflow

功能介绍

查询流程详情

调用方法

请参见如何调用API。

授权信息

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释:

工作空间ID

取值范围:

不涉及

workflow_id

是

String

参数解释:

流程ID

取值范围:

不涉及

请求参数

表2 请求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

表3 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

success

Boolean

参数解释:

是否成功

取值范围:

  • true 成功

  • false 失败

request_id

String

参数解释:

请求的ID

约束限制:

不涉及

data

AopWorkflowInfo object

流程详情
表4 AopWorkflowInfo

参数

参数类型

描述

id

String

参数解释:

流程ID

取值范围:

不涉及

name

String

参数解释:

流程名称

取值范围:

不涉及

description

String

参数解释:

流程的描述

取值范围:

不涉及

project_id

String

参数解释:

租户ID

取值范围:

不涉及

owner_id

String

参数解释:

所有者ID

取值范围:

不涉及

creator_id

String

参数解释:

创建者ID

取值范围:

不涉及

creator_name

String

参数解释:

创建者的名称

取值范围:

不涉及

create_time

String

参数解释:

创建时间

取值范围:

不涉及

modifier_id

String

参数解释:

更新者的ID

取值范围:

不涉及

modifier_name

String

参数解释:

更新者的名称

取值范围:

不涉及

update_time

String

参数解释:

更新的时间

取值范围:

不涉及

edit_role

String

参数解释:

编辑角色

取值范围:

不涉及

use_role

String

参数解释:

使用角色

取值范围:

不涉及

approve_role

String

参数解释:

审核角色

取值范围:

不涉及

enabled

Boolean

参数解释:

是否已启用

取值范围:

  • true 已启用

  • false 未启用

workspace_id

String

参数解释:

工作空间ID

取值范围:

不涉及

version_id

String

参数解释:

流程激活版本ID

取值范围:

不涉及

current_approval_version_id

String

参数解释:

当前待审核版本ID

取值范围:

不涉及

current_rejected_version_id

String

参数解释:

当前拒绝的版本ID

取值范围:

不涉及

aop_type

String

参数解释:

流程的类型

  • NORMAL 通用

  • SURVEY 调查

  • HEMOSTASIS 止血

  • EASE 缓解

取值范围:

  • NORMAL

  • SURVEY

  • HEMOSTASIS

  • EASE

engine_type

String

参数解释:

引擎的类型

  • public_engine 共享版

取值范围:

  • public_engine

dataclass_id

String

参数解释:

数据类的ID

取值范围:

不涉及

dataclass_name

String

参数解释:

数据类的名称

取值范围:

不涉及

labels

String

参数解释:

流程实体类型

  • IP IP

  • ACCOUNT 账号

  • DOMAIN 域名

取值范围:

  • IP

  • ACCOUNT

  • DOMAIN

version

String

参数解释:

当前激活的流程的版本

取值范围:

不涉及

状态码：400

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

无

响应示例

状态码：200

查询流程详情的响应

{
  "code" : "00000000",
  "data" : {
    "aop_type" : "NORMAL",
    "approve_role" : "",
    "create_time" : "2025-07-18T14:44:46.735Z+0800",
    "creator_id" : "5857617f6b8b4981baef587c08ab8b68",
    "creator_name" : "XXX",
    "current_approval_version_id" : "",
    "current_rejected_version_id" : "",
    "dataclass_id" : "e410ae50-43fa-343e-807a-a2a9edb8018e",
    "dataclass_name" : "",
    "description" : "Aop workflow description",
    "edit_role" : "",
    "enabled" : false,
    "engine_type" : "public_engine",
    "id" : "c19470f3-5eaf-4572-82e8-2ff094495919",
    "labels" : "IP",
    "modifier_id" : "",
    "modifier_name" : "",
    "name" : "Test_aop",
    "owner_id" : "",
    "project_id" : "f69081793d9e4ea8a2f479dcef961989",
    "update_time" : "2025-07-18T14:44:46.735Z+0800",
    "use_role" : "",
    "version" : "",
    "version_id" : "",
    "workspace_id" : "f44065f5-557b-4376-ae02-8c65ef1960f4"
  },
  "message" : "",
  "request_id" : "",
  "success" : true
}

状态码

状态码

描述

200

查询流程详情的响应

400

异常的响应

错误码

请参见错误码。

父主题： 流程管理

相关文档