文档首页/ 函数工作流 FunctionGraph/ API参考/ API/ 函数流/ 修改指定函数流实例的元数据
更新时间:2025-07-11 GMT+08:00
分享

修改指定函数流实例的元数据

功能介绍

修改指定函数流实例的元数据

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/ffs/graphs/{workflow_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户项目 ID,获取方式请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符

默认取值:

不涉及。

workflow_id

String

参数解释:

函数工作流ID。

约束限制:

不涉及。

取值范围:

[1, 512]

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

id

String

流程定义ID

name

String

名字

description

String

描述

nodes

Array of GraphNode objects

nodes

edges

Array of GraphEdge objects

edges

constants

String

constants

label

String

label

enterprise_project_id

String

enterprise_project_id

merge_params

Boolean

merge_params

mode

String

mode

enable_stream_response

Boolean

是否返回流数据

express_config

ExpressConfig object

参数解释:

FunctionGraph工作流快速工作流配置项。

约束限制

快速函数流模式配置,当mode为EXPRESS时需要设置。

取值范围:

不涉及。

默认取值

不涉及。

表3 GraphNode

参数

是否必选

参数类型

描述

id

String

ID

name

String

名称

category

String

种类

description

String

描述

parent_node

String

parent_node

shape

Shape object

shape

position_x

Integer

position_x

position_y

Integer

position_y

execution_id

String

流程节点执行ID

incoming_edges

Array of strings

incoming_edges

outgoing_edges

Array of strings

outgoing_edges

表4 GraphEdge

参数

是否必选

参数类型

描述

id

String

id

from

String

from

to

String

to

label

String

label

shape

Shape object

shape

表5 Shape

参数

是否必选

参数类型

描述

geometry

String

geometry

style

String

style

表6 ExpressConfig

参数

是否必选

参数类型

描述

log_level

String

参数解释:

日志级别

取值范围:

  • ALL:全部日志

  • ERROR:错误日志

  • NONE:不记录日志

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

id

String

参数解释:

工作流ID

取值范围:

不涉及。

workflow_urn

String

参数解释:

函数工作流URN,格式为:

urn:fss:<region_id>:<project_id>:workflow:<package>:<workflow_name>:<version>

注意:

package当前只支持default

version当前只支持latest

取值范围:

不涉及。

name

String

参数解释:

工作流名称

取值范围:

不涉及。

description

String

参数解释:

工作流描述

取值范围:

不涉及。

created_time

String

参数解释:

工作流创建时间

取值范围:

格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间

updated_time

String

参数解释:

工作流修改时间

取值范围:

格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间

created_by

String

参数解释:

工作流创建者

取值范围:

不涉及。

enable_stream_response

Boolean

参数解释:

工作流是否支持stream返回

取值范围:

不涉及。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

request_id

String

请求ID

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

request_id

String

请求ID

请求示例

响应示例

状态码

状态码

描述

200

Success

400

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档