# 修改指定函数流实例的元数据 - UpdateWorkFlow #### 功能介绍 修改指定函数流实例的元数据 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-functiongraph/functiongraph_06_0200.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-functiongraph/functiongraph_06_1100.html)。 #### URI PUT /v2/{project_id}/fgs/workflows/{workflow_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户项目 ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-functiongraph/functiongraph_06_0260.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | workflow_id | 是 | String | **参数解释：** 函数工作流ID。 **约束限制：** 不涉及。 **取值范围：** \[1, 512\] **默认取值：** 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释：** FunctionGraph工作流名称。 **约束限制：** RegExp=\^(\[_a-zA-Z0-9().-\]\|\[\\u4e00-\\u9fa5\]){1,64}$ **取值范围：** \[1, 64\] **默认取值：** 不涉及。 | | description | 否 | String | **参数解释：** FunctionGraph工作流描述。 **约束限制：** RegExp=\^(\[_a-zA-Z0-9().-\]\|\[\\u4e00-\\u9fa5\]){1,512}$ **取值范围：** \[1, 512\] **默认取值：** 不涉及。 | | start | 是 | String | **参数解释：** FunctionGraph工作流开始节点ID。 **约束限制：** 不涉及。 **取值范围：** \[1, 256\] **默认取值：** 不涉及。 | | triggers | 否 | Array of [Trigger] objects | **参数解释：** FunctionGraph工作流触发器列表。 **约束限制：** 不涉及。 **取值范围：** \[0, 200\] **默认取值：** 不涉及。 | | functions | 是 | Array of [Function] objects | **参数解释：** FunctionGraph工作流函数列表。 **约束限制：** 不涉及。 **取值范围：** \[0, 100\] **默认取值：** 不涉及。 | | states | 是 | Array of [OperationState] objects | **参数解释：** FunctionGraph工作流节点列表。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值：** 不涉及。 | | constants | 是 | Object | **参数解释：** FunctionGraph工作流常量。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | retries | 是 | Array of [Retry] objects | **参数解释**: FunctionGraph工作流重试策略列表。 **约束限制**: 不涉及。 **取值范围**: \[0, 200\] **默认取值**: 不涉及。 | | mode | 否 | String | **参数解释：** FunctionGraph工作流模式，默认标准模式。 **约束限制：** 不涉及。 **取值范围：** - NORMAL**：**标注模式 - EXPRESS**：**快速模式 **默认取值：** NORMAL | | express_config | 否 | [ExpressConfig] object | **参数解释：** 快速函数流模式配置，当mode为EXPRESS时需要设置。 **取值范围：** 不涉及。 | | enterprise_project_id | 否 | String | **参数解释：** FunctionGraph工作流企业项目。 **约束限制：** 不涉及。 **取值范围：** \[0, 64\] **默认取值：** 不涉及。 | | enable_stream_response | 否 | Boolean | **参数解释：** FunctionGraph工作流是否支持流式返回。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** false | 表3Trigger | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | trigger_name | 是 | String | **参数解释：** 触发器名称。 **取值范围：** 不涉及。 | | trigger_type | 是 | String | **参数解释**： 触发器类型。 **取值范围** **：** - FLOWTIMER：定时触发器 - SMN：SMN触发器 - APIG_DE：APIG触发器(专享版) - OBS：OBS触发器 | | enabled | 否 | Boolean | **参数解释**: 是否启用触发器。 **取值范围**: 不涉及。 | | trigger_config | 否 | [OBSTriggerConfig] object | **参数解释**: OBS触发器配置。 **取值范围**: 不涉及。 | 表4OBSTriggerConfig | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bucket | 是 | String | **参数解释**: OBS桶名。 最小长度：**1** 最大长度：**64** **取值范围**: 不涉及。 | | events | 是 | Array of strings | **参数解释**: OBS事件列表（trigger_type为OBS时配置）。 数组长度：**1 - 64** **取值范围**: 不涉及。 | | prefix | 是 | String | **参数解释**: 对象名前缀（trigger_type为OBS时配置）。 最小长度：**1** 最大长度：**1024** **取值范围**: 不涉及。 | | suffix | 是 | String | **参数解释**: 对象名后缀（trigger_type为OBS时配置）。 最小长度：**1** 最大长度：**1024** **取值范围**: 不涉及。 | 表5Function | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**: 函数名称，在单个流程中，名称需要唯一。 最小长度：**0** 最大长度：**256** **取值范围**: 不涉及。 | | operation | 是 | String | **参数解释**: 函数调用URN。 最小长度：**0** 最大长度：**256** **取值范围**: 不涉及。 | | metadata | 否 | Object | **参数解释**: 函数扩展属性，由用户自己定制。 **取值范围**: 不涉及。 | 表6OperationState | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | action_mode | 否 | String | **参数解释**: 节点执行模式 **取值范围**: - sequential: 串行模式 - parallel: 并行模式 | | actions | 是 | Array of [Action] objects | **参数解释**: 节点执行操作列表 **取值范围**: 不涉及。 | | on_errors | 否 | Array of [OnError] objects | **参数解释**: 节点执行错误处理策略列表 **取值范围**: 不涉及。 | | id | 是 | String | **参数解释**: 节点ID, 工作流中唯一 **取值范围**: 不涉及。 | | name | 是 | String | **参数解释**: 节点名称 **取值范围**: 不涉及。 | | type | 是 | String | **参数解释**: 节点类型表 **取值范围**: - Operation: 操作节点 - Sleep: 暂停节点 - End: 结束节点 | | end | 是 | Boolean | **参数解释**: 是否是结束节点 **取值范围**: 不涉及。 | | transition | 是 | String | **参数解释**: 下一节点ID **取值范围**: 不涉及。 | | state_data_filter | 否 | [StateDataFilter] object | **参数解释**: 过滤表达式 **取值范围**: 不涉及。 | | duration | 否 | Long | **参数解释**: 时间等待节点等待时间（秒）,节点类型为Sleep时为必填，节点类型不为Sleep时无效 **取值范围**: 不涉及。 | 表7Action | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | function_ref | 否 | [FunctionRef] object | **参数解释**: 函数调用信息 **取值范围**: 不涉及。 | 表8FunctionRef | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ref_name | 是 | String | **参数解释**: 函数引用名称, 需要和外层functions中的name对应 **取值范围**: 不涉及。 | | invoke_mode | 否 | String | **参数解释**: 函数调用模式, 目前只支持同步调用 **取值范围**: - synchronize: 同步调用 - asynchronous: 异步调用 | | arguments | 是 | Object | **参数解释** 函数执行时的入参，支持引用constants中的常量。 定义方式：参数路径 \| 常量值/常量路径 参数路径指输入参数的JsonPath路径，如$.a.b\[0\].c 常量值可以为数字类型，字符串类型(需要用单引号括起来)，布尔类型。 常量路径为常量的JsonPath路径，但是根节点需要用$CONST表示，示例：$CONST.a.b **取值范围** 不涉及。 | 表9OnError | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | error | 否 | String | **参数解释**: 错误匹配表达式，用来过滤需要处理的异常。 **取值范围**: 不涉及。 | | transition | 否 | String | **参数解释**: 下一步骤节点ID。 **取值范围**: 不涉及。 | | retry_ref | 否 | String | **参数解释**: 重试策略名称。 **取值范围**: 不涉及。 | 表10StateDataFilter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | input | 否 | String | **参数解释**: 输入过滤表达式（JsonPath）。 **取值范围**: 不涉及。 | | output | 否 | String | **参数解释**: 输出过滤表达式（JsonPath）。 **取值范围**: 不涉及。 | 表11Retry | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**: 重试策略名称，在单个流程中，名称需要唯一。 **取值范围**: 不涉及。 | | delay | 否 | Long | **参数解释**: 重试间隔，单位：秒。若不传，默认为1。 **取值范围**: 不涉及。 | | max_attempts | 否 | Long | **参数解释**: 最大重试次数，若不传，默认为3。 **取值范围**: 不涉及。 | 表12ExpressConfig | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | log_level | 否 | String | **参数解释**： 快速模式相关配置，仅在mode配置为EXPRESS时生效 快速模式下流程的执行日志级别。 注意：当配置为ALL和ERROR级别时租户需要开启LTS相关权限。 最小长度:**1** 最大长度:**5** **取值范围：** - **ALL**：记录所有节点的执行日志。 - **ERROR**：仅记录异常节点执行日志。 - **NONE**：不记录日志。 | #### 响应参数 **状态码: 200** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**: 工作流ID。 **取值范围**: 不涉及。 | | workflow_urn | String | **参数解释**: 函数工作流URN，格式为： urn:fss:\:\:workflow:\:\:\ 注意： 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** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | | request_id | String | 请求ID | **状态码: 500** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | | request_id | String | 请求ID | #### 请求示例 修改函数流id为{workflow_id}的函数流元数据。 ``` PUT /v2/{project_id}/fgs/workflows/{workflow_id} { "name" : "workflow_test", "start" : "test", "functions" : [ { "name" : "test", "operation" : "urn:fss:{regin}:c53626012ba84727b938ca8bf03108ef:test:latest" } ], "constants" : { }, "states" : [ { "id" : "test", "name" : "test", "type" : "Operation", "end" : false, "transition" : "end", "actions" : [ { "function_ref" : { "ref_name" : "test", "arguments" : { "execution_name" : "$.test" } } } ] }, { "id" : "end", "name" : "end", "type" : "End", "end" : true, "transition" : "", "state_data_filter" : { "input" : "", "output" : "" }, "actions" : [ ] } ], "retries" : [ { "name" : "test" } ] } ``` #### 响应示例 **状态码: 200** Success ``` { "id" : "48aff955-ea10-4ffd-b426-190bc192dc14", "workflow_urn" : "urn:fss:cn-north-7:73d69ae0cfcf460190522d060f05ad:workflow:default:testflow:latest", "name" : "test-flow", "description" : "desc", "created_time" : "2021-01-01T00:00:00Z", "updated_time" : "2021-01-01T00:00:00Z", "created_by" : "admin" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java 修改函数流id为{workflow_id}的函数流元数据。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.functiongraph.v2.region.FunctionGraphRegion; import com.huaweicloud.sdk.functiongraph.v2.*; import com.huaweicloud.sdk.functiongraph.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdateWorkFlowSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext， which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example， AK and SK are stored in environment variables for authentication. Before running this example， set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); FunctionGraphClient client = FunctionGraphClient.newBuilder() .withCredential(auth) .withRegion(FunctionGraphRegion.valueOf("")) .build(); UpdateWorkFlowRequest request = new UpdateWorkFlowRequest(); WorkflowCreateBody body = new WorkflowCreateBody(); List listbodyRetries = new ArrayList<>(); listbodyRetries.add( new Retry() .withName("test") ); StateDataFilter stateDataFilterStates = new StateDataFilter(); stateDataFilterStates.withInput("") .withOutput(""); FunctionRef functionRefActions = new FunctionRef(); functionRefActions.withRefName("test") .withArguments("{\"execution_name\":\"$.test\"}"); List listStatesActions = new ArrayList<>(); listStatesActions.add( new Action() .withFunctionRef(functionRefActions) ); List listbodyStates = new ArrayList<>(); listbodyStates.add( new OperationState() .withActions(listStatesActions) .withId("test") .withName("test") .withType(OperationState.TypeEnum.fromValue("Operation")) .withEnd(false) .withTransition("end") ); listbodyStates.add( new OperationState() .withActionMode(OperationState.ActionModeEnum.fromValue("")) .withActions() .withId("end") .withName("end") .withType(OperationState.TypeEnum.fromValue("End")) .withEnd(true) .withTransition("") .withStateDataFilter(stateDataFilterStates) ); List listbodyFunctions = new ArrayList<>(); listbodyFunctions.add( new Function() .withName("test") .withOperation("urn:fss:{regin}:c53626012ba84727b938ca8bf03108ef:test:latest") ); body.withRetries(listbodyRetries); body.withConstants(new Object()); body.withStates(listbodyStates); body.withFunctions(listbodyFunctions); body.withStart("test"); body.withName("workflow_test"); request.withBody(body); try { UpdateWorkFlowResponse response = client.updateWorkFlow(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` #### Python 修改函数流id为{workflow_id}的函数流元数据。 ``` # coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkfunctiongraph.v2.region.functiongraph_region import FunctionGraphRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkfunctiongraph.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext， which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example， AK and SK are stored in environment variables for authentication. Before running this example， set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = FunctionGraphClient.new_builder() \ .with_credentials(credentials) \ .with_region(FunctionGraphRegion.value_of("")) \ .build() try: request = UpdateWorkFlowRequest() listRetriesbody = [ Retry( name="test" ) ] stateDataFilterStates = StateDataFilter( input=""， output="" ) functionRefActions = FunctionRef( ref_name="test"， arguments="{\"execution_name\":\"$.test\"}" ) listActionsStates = [ Action( function_ref=functionRefActions ) ] listStatesbody = [ OperationState( actions=listActionsStates， id="test"， name="test"， type="Operation"， end=False， transition="end" )， OperationState( action_mode=""， id="end"， name="end"， type="End"， end=True， transition=""， state_data_filter=stateDataFilterStates ) ] listFunctionsbody = [ Function( name="test"， operation="urn:fss:{regin}:c53626012ba84727b938ca8bf03108ef:test:latest" ) ] request.body = WorkflowCreateBody( retries=listRetriesbody， constants={}， states=listStatesbody， functions=listFunctionsbody， start="test"， name="workflow_test" ) response = client.update_work_flow(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go 修改函数流id为{workflow_id}的函数流元数据。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" functiongraph "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext， which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example， AK and SK are stored in environment variables for authentication. Before running this example， set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := functiongraph.NewFunctionGraphClient( functiongraph.FunctionGraphClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). Build()) request := &model.UpdateWorkFlowRequest{} var listRetriesbody = []model.Retry{ { Name: "test"， }， } inputStateDataFilter:= "" outputStateDataFilter:= "" stateDataFilterStates := &model.StateDataFilter{ Input: &inputStateDataFilter， Output: &outputStateDataFilter， } var argumentsFunctionRef interface{} = "{\"execution_name\":\"$.test\"}" functionRefActions := &model.FunctionRef{ RefName: "test"， Arguments: &argumentsFunctionRef， } var listActionsStates = []model.Action{ { FunctionRef: functionRefActions， }， } actionModeStates:= model.GetOperationStateActionModeEnum().EMPTY var listStatesbody = []model.OperationState{ { Actions: listActionsStates， Id: "test"， Name: "test"， Type: model.GetOperationStateTypeEnum().OPERATION， End: false， Transition: "end"， }， { ActionMode: &actionModeStates， Id: "end"， Name: "end"， Type: model.GetOperationStateTypeEnum().END， End: true， Transition: ""， StateDataFilter: stateDataFilterStates， }， } var listFunctionsbody = []model.Function{ { Name: "test"， Operation: "urn:fss:{regin}:c53626012ba84727b938ca8bf03108ef:test:latest"， }， } var constantsWorkflowCreateBody interface{} = make(map[string]string) request.Body = &model.WorkflowCreateBody{ Retries: listRetriesbody， Constants: &constantsWorkflowCreateBody， States: listStatesbody， Functions: listFunctionsbody， Start: "test"， Name: "workflow_test"， } response， err := client.UpdateWorkFlow(request) if err == nil { fmt.Printf("%+v\n"， response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/FunctionGraph/sdk?api=UpdateWorkFlow)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success | | 400 | Bad Request | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-functiongraph/ErrorCode.html)。