Modifying the Instance Metadata of a Specified Flow

Function

This API is used to modify the instance metadata of a specified flow.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A. Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A.
workflow_id	Yes	String	Definition Flow ID. Constraints N/A. Range 1 to 512 characters Default Value N/A.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
id	No	String	Flow instance ID.
name	No	String	Name.
description	No	String	Description.
nodes	No	Array of GraphNode objects	nodes
edges	No	Array of GraphEdge objects	edges
constants	No	String	constants
label	No	String	label
enterprise_project_id	No	String	enterprise_project_id
merge_params	No	Boolean	merge_params
mode	No	String	mode
enable_stream_response	No	Boolean	Whether to return stream data.
express_config	No	ExpressConfig object	Definition Express flow configuration items of FunctionGraph. Constraints Express flow configuration. This parameter is required when mode is set to EXPRESS. Range N/A. Default Value N/A.

**Table 3** GraphNode
Parameter	Mandatory	Type	Description
id	No	String	ID
name	No	String	Name.
category	No	String	Category.
description	No	String	Description.
parent_node	No	String	parent_node
shape	No	Shape object	shape
position_x	No	Integer	position_x
position_y	No	Integer	position_y
execution_id	No	String	Execution ID.
incoming_edges	No	Array of strings	incoming_edges
outgoing_edges	No	Array of strings	outgoing_edges

**Table 4** GraphEdge
Parameter	Mandatory	Type	Description
id	No	String	id
from	No	String	from
to	No	String	to
label	No	String	label
shape	No	Shape object	shape

**Table 5** Shape
Parameter	Mandatory	Type	Description
geometry	No	String	geometry
style	No	String	style

**Table 6** ExpressConfig
Parameter	Mandatory	Type	Description
log_level	No	String	Definition Log level. Range ALL: all logs ERROR: error logs NONE: no logs

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
id	String	Definition Flow ID. Range N/A.
workflow_urn	String	Definition Flow URN. The format is as follows: urn:fss:<region_id>:<project_id>:workflow:<package>:<workflow_name>:<version> Notes: Currently, only default is supported for package. Currently, only latest is supported for version. Range N/A.
name	String	Definition Flow name. Range N/A.
description	String	Definition Flow description. Range N/A.
created_time	String	Definition Flow creation time. Range Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
updated_time	String	Definition Flow modification time. Range Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
created_by	String	Definition Flow creator Range N/A.
enable_stream_response	Boolean	Definition Whether the flow supports streaming response. Range N/A.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
request_id	String	Request ID.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
request_id	String	Request ID.

Example Requests

None

Example Responses

None

Status Codes

Status Code	Description
200	Success
400	Bad Request
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Function Flows

Previous topic: Querying an Instance of a Specified Flow

Next topic: Obtaining the List of Specified Metadata Categories