更新时间:2025-08-30 GMT+08:00
分享

校验流程版本

功能介绍

校验流程版本.

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/workflows/validation

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_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

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

mode

String

参数解释:

流程的校验类型

  • BASIC 基础校验

  • CIRCLE 环路校验

  • APP_PARAMS 参数校验

约束限制:

不涉及

取值范围:

  • BASIC

  • CIRCLE

  • APP_PARAMS

默认值:

不涉及

taskconfig

String

参数解释:

流程拓扑图的参数配置

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

taskflow

String

参数解释:

流程的拓扑图的BASE64编码

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

aopworkflow_id

String

参数解释:

流程的ID

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

data

data object

validate data

表5 data

参数

参数类型

描述

mode

String

参数解释:

流程的校验类型

  • BASIC 基础校验

  • CIRCLE 环路校验

  • APP_PARAMS 参数校验

取值范围:

  • BASIC

  • CIRCLE

  • APP_PARAMS

result

Boolean

参数解释:

参数校验结果

  • true 校验成功

  • false 校验失败

取值范围:

  • true

  • false

detail

String

参数解释:

参数校验结果描述

取值范围:

不涉及,校验失败时给出具体的失败原因说明

状态码:400

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

进行流程环路校验的样例

/v1/15645222e8744afa985c93dab6341da6/workspaces/985c8a9f-de13-4af2-9109-fabc1719387c/soc/workflows/validation

{
  "aopworkflow_id" : "91355942-aa54-46d3-b7a8-c7ac8408192f",
  "taskflow" : "eyJlbGVtZW50VHlwZSI6Int9Iiwid29ya2Zsb3ciOnsiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmRlZmluaXRpb25zIiwiYXR0cmlidXRlcyI6eyJ4bWxuczp4c2kiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYS1pbnN0YW5jZSIsInhtbG5zOmJwbW4yIjoiaHR0cDovL3d3dy5vbWcub3JnL3NwZWMvQlBNTi8yMDEwMDUyNC9NT0RFTCIsInhtbG5zOmJwbW5kaSI6Imh0dHA6Ly93d3cub21nLm9yZy9zcGVjL0JQTU4vMjAxMDA1MjQvREkiLCJ4bWxuczpkYyI6Imh0dHA6Ly93d3cub21nLm9yZy9zcGVjL0RELzIwMTAwNTI0L0RDIiwieG1sbnM6ZGkiOiJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9ERC8yMDEwMDUyNC9ESSIsInhtbG5zOnNvYXIiOiJodHRwczovL3NvYy5jbG91ZHNyZS5jb20vc29hci92MiIsImlkIjoiZGlhZ3JhbV9Qcm9jZXNzXzE3NTUyMzk1MjQ1MzgiLCJ0YXJnZXROYW1lc3BhY2UiOiJodHRwOi8vZmxvd2FibGUub3JnL2JwbW4iLCJ4c2k6c2NoZW1hTG9jYXRpb24iOiJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9CUE1OLzIwMTAwNTI0L01PREVMIEJQTU4yMC54c2QifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOnByb2Nlc3MiLCJhdHRyaWJ1dGVzIjp7ImlkIjoiUHJvY2Vzc18xNzU1MjM5NTI0NTM4IiwibmFtZSI6IlNlcnZpY2VfUHJvY2VzczE3NTUyMzk1MjQ1MzgiLCJpc0V4ZWN1dGFibGUiOiJ0cnVlIn0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJicG1uMjpzdGFydEV2ZW50IiwiYXR0cmlidXRlcyI6eyJpZCI6IkV2ZW50XzB2dWl6YjcifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOm91dGdvaW5nIiwiZWxlbWVudHMiOlt7InR5cGUiOiJ0ZXh0IiwidGV4dCI6IkZsb3dfMHBqZjA1aiJ9XX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmVuZEV2ZW50IiwiYXR0cmlidXRlcyI6eyJpZCI6IkV2ZW50XzFvNTdqYzEifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOmluY29taW5nIiwiZWxlbWVudHMiOlt7InR5cGUiOiJ0ZXh0IiwidGV4dCI6IkZsb3dfMHBqZjA1aiJ9XX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW4yOnNlcXVlbmNlRmxvdyIsImF0dHJpYnV0ZXMiOnsiaWQiOiJGbG93XzBwamYwNWoiLCJzb3VyY2VSZWYiOiJFdmVudF8wdnVpemI3IiwidGFyZ2V0UmVmIjoiRXZlbnRfMW81N2pjMSJ9fV19LHsidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5EaWFncmFtIiwiYXR0cmlidXRlcyI6eyJpZCI6IkJQTU5EaWFncmFtXzEifSwiZWxlbWVudHMiOlt7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW5kaTpCUE1OUGxhbmUiLCJhdHRyaWJ1dGVzIjp7ImlkIjoiQlBNTlBsYW5lXzEiLCJicG1uRWxlbWVudCI6IlByb2Nlc3NfMTc1NTIzOTUyNDUzOCJ9LCJlbGVtZW50cyI6W3sidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5TaGFwZSIsImF0dHJpYnV0ZXMiOnsiaWQiOiJFdmVudF8wdnVpemI3X2RpIiwiYnBtbkVsZW1lbnQiOiJFdmVudF8wdnVpemI3In0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJkYzpCb3VuZHMiLCJhdHRyaWJ1dGVzIjp7IngiOiItMjY4IiwieSI6Ii0xNzgiLCJ3aWR0aCI6IjM2IiwiaGVpZ2h0IjoiMzYifX1dfSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImJwbW5kaTpCUE1OU2hhcGUiLCJhdHRyaWJ1dGVzIjp7ImlkIjoiRXZlbnRfMW81N2pjMV9kaSIsImJwbW5FbGVtZW50IjoiRXZlbnRfMW81N2pjMSJ9LCJlbGVtZW50cyI6W3sidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiZGM6Qm91bmRzIiwiYXR0cmlidXRlcyI6eyJ4IjoiNzIiLCJ5IjoiLTE3OCIsIndpZHRoIjoiMzYiLCJoZWlnaHQiOiIzNiJ9fV19LHsidHlwZSI6ImVsZW1lbnQiLCJuYW1lIjoiYnBtbmRpOkJQTU5FZGdlIiwiYXR0cmlidXRlcyI6eyJpZCI6IkZsb3dfMHBqZjA1al9kaSIsImJwbW5FbGVtZW50IjoiRmxvd18wcGpmMDVqIn0sImVsZW1lbnRzIjpbeyJ0eXBlIjoiZWxlbWVudCIsIm5hbWUiOiJkaTp3YXlwb2ludCIsImF0dHJpYnV0ZXMiOnsieCI6Ii0yMzIiLCJ5IjoiLTE2MCJ9fSx7InR5cGUiOiJlbGVtZW50IiwibmFtZSI6ImRpOndheXBvaW50IiwiYXR0cmlidXRlcyI6eyJ4IjoiNzIiLCJ5IjoiLTE2MCJ9fV19XX1dfV19XX19",
  "taskconfig" : "{\"node_info\":{},\"usertask_info\":{}}",
  "mode" : "CIRCLE"
}

响应示例

状态码:200

Response of validating aopworkflow version

{
  "code" : "00000000",
  "data" : {
    "detail" : "Pass",
    "mode" : "CIRCLE",
    "result" : true
  },
  "message" : "",
  "request_id" : "",
  "success" : true
}

状态码

状态码

描述

200

Response of validating aopworkflow version

400

Error response

错误码

请参见错误码

相关文档