华为云用户手册

  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 group_name String 日志组名称 group_id String 日志组id stream_id String 日志流id stream_name String 日志流名称 状态码: 403 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 OK { "workflow_id" : "48aff955-ea10-4ffd-b426-190bc192dc14", "workflow_urn" : "urn:fss:cn-north-7:73d69ae0cfcf460190522d060f05ad:workflow:default:testflow:latest", "execution_id" : "48aff955-ea10-4ffd-b426-190bc192dc14", "status" : "running", "headers" : { "tenantId" : "user1" }, "input" : { "arg1" : "argument_1", "arg2" : "argument_2" }, "output" : { "arg1" : "argument_1", "arg2" : "argument_2" }, "begin_time" : "2021-01-01T00:00:00Z", "end_time" : "2021-01-01T00:00:00Z", "last_update_time" : "2021-01-01T00:00:00Z", "created_by" : "admin", "node_execution_details" : [ { "node_id" : "48aff955-ea10-4ffd-b426-190bc192dc14", "node_name" : "string", "execution_id" : "string", "executions" : [ { "status" : "running", "input" : { "arg1" : "argument_1", "arg2" : "argument_2" }, "output" : { "arg1" : "argument_1", "arg2" : "argument_2" }, "begin_time" : 1605119892050, "end_time" : 1605119892050, "error_message" : { "detail:\"Execution failed\"" : null }, "request_id" : "string" } ] } ]}
  • URI GET /v2/{project_id}/fgs/workflows/{workflow_id}/executions/{execution_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 最小长度:1 最大长度:64 workflow_id 是 String 函数工作流 ID 最小长度:1 最大长度:512 execution_id 是 String 函数流执行实例ID 最小长度:1 最大长度:64
  • 响应示例 状态码: 200 查询成功 { "statistics" : { "count" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 2 }, { "timestamp" : 1596686400000, "value" : -1 } ], "duration" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 950 }, { "timestamp" : 1596686400000, "value" : -1 } ], "fail_count" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 0 }, { "timestamp" : 1596686400000, "value" : -1 } ], "max_duration" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 740 }, { "timestamp" : 1596686400000, "value" : -1 } ], "min_duration" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 210 }, { "timestamp" : 1596686400000, "value" : -1 } ], "reject_count" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 0 }, { "timestamp" : 1596686400000, "value" : -1 } ] }}
  • URI GET /v2/{project_id}/fgs/functions/statistics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目 ID,获取方式请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 filter 是 String 参数过滤器。 monitor_data: 查询统计信息。 monthly_report:查询月度统计信息。 枚举值: monitor_data monthly_report period 否 String 时间段单位为分钟,与filter参数metric配合使用。 option 否 String 月度统计的维度,filter参数取值为monthly_report时才生效。 当取值不在以上范围时,默认取"0"。 "0": 表示统计本月。 "1": 表示统计上月。 "2": 表示统计最近三个月。 "3": 表示统计最近六个月。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Array of MonthUsed objects 月度调用次数 gbs Array of MonthUsed objects 月度资源用量 statistics ListFunctionStatisticsResponseBody object 函数指标 表5 MonthUsed 参数 参数类型 描述 date String 日期 value Number 使用量 表6 ListFunctionStatisticsResponseBody 参数 参数类型 描述 count Array of SlaReportsValue objects 调用次数 duration Array of SlaReportsValue objects 平均时延,单位毫秒 fail_count Array of SlaReportsValue objects 错误次数 max_duration Array of SlaReportsValue objects 最大时延,单位毫秒 min_duration Array of SlaReportsValue objects 最小时延,单位毫秒 reject_count Array of SlaReportsValue objects 被拒绝次数 表7 SlaReportsValue 参数 参数类型 描述 timestamp Integer 时间戳 value Double 值 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 查询成功 { "quotas" : { "resources" : [ { "quota" : 60, "used" : 3, "type" : "fgs_func_scale_down_timeout" }, { "quota" : 100, "used" : 22, "type" : "fgs_func_occurs" }, { "quota" : 100, "used" : 22, "type" : "fgs_func_pat_idle_time" }, { "quota" : 100, "used" : 22, "type" : "fgs_func_num" }, { "quota" : 10240, "used" : 22, "type" : "fgs_func_code_size", "unit" : "MB" }, { "quota" : 512, "used" : 22, "type" : "fgs_workflow_num" } ] }}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 quotas ListQuotasResult object 配额信息 表4 ListQuotasResult 参数 参数类型 描述 resources Array of Resources objects 配额列表 表5 Resources 参数 参数类型 描述 quota Integer 函数配额限制。 used Integer 已使用的配额。 type String “资源类型” 枚举值: fgs_func_scale_down_timeout fgs_func_occurs fgs_func_pat_idle_time fgs_func_num fgs_func_code_size fgs_workflow_num unit String 资源的计数单位。fgs_func_code_size,单位为MB,其他场景无单位 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 ok { "count" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 2 }, { "timestamp" : 1596686400000, "value" : -1 } ], "duration" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 950 }, { "timestamp" : 1596686400000, "value" : -1 } ], "fail_count" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 0 }, { "timestamp" : 1596686400000, "value" : -1 } ], "max_duration" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 740 }, { "timestamp" : 1596686400000, "value" : -1 } ], "min_duration" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 210 }, { "timestamp" : 1596686400000, "value" : -1 } ], "reject_count" : [ { "timestamp" : 1596679200000, "value" : -1 }, { "timestamp" : 1596682800000, "value" : 0 }, { "timestamp" : 1596686400000, "value" : -1 } ]}
  • URI GET /v2/{project_id}/fgs/functions/{func_urn}/statistics/{period} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目 ID,获取方式请参见获取项目ID。 func_urn 是 String 函数的URN,详细解释见FunctionGraph函数模型的描述。 period 是 String 获取最近多少分钟内函数执行的指标。 最小值:0 最大值:0 最小长度:0 最大长度:0
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Array of SlaReportsValue objects 调用次数 duration Array of SlaReportsValue objects 平均时延,单位毫秒 fail_count Array of SlaReportsValue objects 错误次数 max_duration Array of SlaReportsValue objects 最大时延,单位毫秒 min_duration Array of SlaReportsValue objects 最小时延,单位毫秒 reject_count Array of SlaReportsValue objects 被拒绝次数 表4 SlaReportsValue 参数 参数类型 描述 timestamp Integer 时间戳 value Double 值
  • URI PUT /v2/{project_id}/fgs/functions/{function_urn}/events/{event_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目 ID,获取方式请参见获取项目ID。 function_urn 是 String 函数的URN,详细解释见FunctionGraph函数模型的描述。 event_id 是 String 测试事件ID
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 测试事件ID。 name String 测试事件名称。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • URI GET /v2/{project_id}/fgs/functions/{function_urn}/events/{event_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目 ID,获取方式请参见获取项目ID。 function_urn 是 String 函数的URN,详细解释见FunctionGraph函数模型的描述。 event_id 是 String 测试事件ID
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 测试事件ID。 name String 测试事件名称。 content String 测试事件content。 last_modified Number 上次修改的时间。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应参数 状态码: 401 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 测试事件名称。只能由字母、数字、中划线和下划线组成,且必须以大写或小写字母开头 content 是 String 测试事件content,为json字符串
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 测试事件ID。 name String 测试事件名称。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 ok 示例 1 null 示例 2 { "id" : "4f4ae4eb-dcdc-4dd3-bffd-79600bd972b3", "owner" : "*****", "link" : "https://{bukcet}.{obs_endpoint}/depends/****/4f4ae4eb-dcdc-4dd3-bffd-79600bd972b3.zip", "runtime" : "Python3.6", "etag" : "83863be4b6c3a86aef995dbc83aae68f", "size" : 577118, "name" : "python-kafka", "description" : "python支持kafka操作的库", "file_name" : "python-kafka.zip"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 依赖包ID。 owner String 依赖包拥有者。 link String 依赖包在obs的存储地址。 runtime String FunctionGraph函数的执行环境 Python2.7: Python语言2.7版本。 Python3.6: Pyton语言3.6版本。 Python3.9: Python语言3.9版本。 Go1.8: Go语言1.8版本。 Go1.x: Go语言1.x版本。 Java8: Java语言8版本。 Java11: Java语言11版本。 Node.js6.10: Nodejs语言6.10版本。 Node.js8.10: Nodejs语言8.10版本。 Node.js10.16: Nodejs语言10.16版本。 Node.js12.13: Nodejs语言12.13版本。 Node.js14.18: Nodejs语言14.18版本。 C#(.NET Core 2.0): C#语言2.0版本。 C#(.NET Core 2.1): C#语言2.1版本。 C#(.NET Core 3.1): C#语言3.1版本。 Custom: 自定义运行时。 PHP7.3: Php语言7.3版本。 http: HTTP函数。 枚举值: Java8 Java11 Node.js6.10 Node.js8.10 Node.js10.16 Node.js12.13 Node.js14.18 Python2.7 Python3.6 Go1.8 Go1.x C#(.NET Core 2.0) C#(.NET Core 2.1) C#(.NET Core 3.1) Custom PHP7.3 Python3.9 http etag String 依赖包唯一标志。 size Long 依赖包大小。 name String 依赖包名。 description String 依赖包描述。 file_name String 依赖包文件名。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 depend_file 否 String depend_type为zip类型时必填,为文件流格式,需要base64编码zip文件。 depend_link 否 String depend_type为obs类型时,依赖包在obs的存储地址。 depend_type 是 String 导入类型,目前支持obs和zip。 runtime 是 String FunctionGraph函数的执行环境 Python2.7: Python语言2.7版本。 Python3.6: Pyton语言3.6版本。 Python3.9: Python语言3.9版本。 Go1.8: Go语言1.8版本。 Go1.x: Go语言1.x版本。 Java8: Java语言8版本。 Java11: Java语言11版本。 Node.js6.10: Nodejs语言6.10版本。 Node.js8.10: Nodejs语言8.10版本。 Node.js10.16: Nodejs语言10.16版本。 Node.js12.13: Nodejs语言12.13版本。 Node.js14.18: Nodejs语言14.18版本。 C#(.NET Core 2.0): C#语言2.0版本。 C#(.NET Core 2.1): C#语言2.1版本。 C#(.NET Core 3.1): C#语言3.1版本。 Custom: 自定义运行时。 PHP7.3: Php语言7.3版本。 http: HTTP函数。 枚举值: Java8 Java11 Node.js6.10 Node.js8.10 Node.js10.16 Node.js12.13 Node.js14.18 Python2.7 Python3.6 Go1.8 Go1.x C#(.NET Core 2.0) C#(.NET Core 2.1) C#(.NET Core 3.1) Custom PHP7.3 Python3.9 http name 是 String 依赖包名称。必须以大、小写字母开头,以字母或数字结尾,只能由字母、数字、下划线、点和中划线组成,长度不超过96个字符。 description 否 String 依赖包描述,不超过512个字符。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 测试事件总数。 events Array of ListEventsResult objects 测试事件列表。 next_marker Long 下次读取位置。 表4 ListEventsResult 参数 参数类型 描述 id String 测试事件ID。 last_modified Number 上次修改的时间。 name String 测试事件名称。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 响应示例 状态码: 200 函数流执行查询返回体 { "executions" : [ { "workflow_id" : "48aff955-ea10-4ffd-b426-190bc192dc14", "workflow_urn" : "urn:fss:cn-north-7:73d69ae0cfcf460190522d060f05ad:workflow:default:testflow:latest", "execution_id" : "48aff955-ea10-4ffd-b426-190bc192dc14", "status" : "running", "begin_time" : "2021-01-01T00:00:00Z", "end_time" : "2021-01-01T00:00:00Z", "last_update_time" : "2021-01-01T00:00:00Z", "created_by" : "admin" } ]}
  • URI GET /v2/{project_id}/fgs/workflows/{workflow_id}/executions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 最小长度:1 最大长度:64 workflow_id 是 String 函数工作流ID 最小长度:1 最大长度:512 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询,每页显示的条目数量,最大数量200,超过200后只返回200 最小值:0 最大值:500 status 否 String 需要过滤的流程实例状态 最小长度:0 最大长度:64 枚举值: success fail running timeout cancel start_time 否 String 查询开始时间,UTC时间。若起始时间未填写,以终止时间前推3天为起始时间 end_time 否 String 查询结束时间,UTC时间。若终止时间未填写,以起始时间后退3天未终止时间。若均未填写,默认查询最近3天数据。
  • 请求示例 创建函数流。 POST /v2/{project_id}/fgs/workflows{ "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" : [ ], "action_mode" : "" } ], "retries" : [ { "name" : "test" } ]}
  • 响应示例 状态码: 201 Created { "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"}
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 函数流名称 最小长度:1 最大长度:64 description 否 String 函数流描述 最小长度:1 最大长度:512 start 是 String 流程开始节点ID 最小长度:1 最大长度:256 triggers 否 Array of Trigger objects 触发器列表 functions 是 Array of Function objects 函数列表 states 是 Array of OperationState objects 函数流节点清单,定义参考SleepState和OperationState constants 是 Object 函数流中的常量 retries 是 Array of Retry objects 重试策略清单 mode 否 String 函数流模式,当前支持两种模式NORMAL: 标准模式,普通模式面向普通的业务场景,支持长时间任务,支持执行历史持久化和查询,只支持异步调用EXPRESS: 快速模式,快速模式面向业务执行时长较短,需要极致性能的场景,只支持流程执行时长低于5分钟的场景,不支持执行历史持久化,支持同步和异步调用默认为标准模式 缺省值:NORMAL 枚举值: NORMAL EXPRESS express_config 否 ExpressConfig object 快速函数流模式配置,当mode为EXPRESS时需要设置 enterprise_project_id 否 String 企业项目ID 最小长度:0 最大长度:64 enable_stream_response 否 Boolean 是否返回流数据 缺省值:false 表3 Trigger 参数 是否必选 参数类型 描述 trigger_name 是 String 触发器名称 最小长度:1 最大长度:256 trigger_type 是 String 触发器类型 FLOWTIMER:定时触发器 SMN :SMN触发器 APIG:APIG触发器(共享版) APIG_DE:APIG触发器(专享版) OBS:OBS触发器 最小长度:1 最大长度:32 枚举值: FLOWTIMER SMN APIG APIG_DE OBS enabled 否 Boolean 是否启用触发器 缺省值:true 枚举值: true false trigger_config 否 OBSTriggerConfig object OBS触发器配置,当trigger_type为OBS时需要设置 表4 OBSTriggerConfig 参数 是否必选 参数类型 描述 bucket 是 String OBS桶名(trigger_type为OBS时配置) 最小长度:1 最大长度:64 events 是 Array of strings OBS事件列表(trigger_type为OBS时配置) prefix 是 String 对象名前缀(trigger_type为OBS时配置) 最小长度:1 最大长度:1024 suffix 是 String 对象名后缀(trigger_type为OBS时配置) 最小长度:1 最大长度:1024 表5 Function 参数 是否必选 参数类型 描述 name 是 String 函数名称,在单个流程中,名称需要唯一 最小长度:0 最大长度:256 operation 是 String 函数调用URN 最小长度:0 最大长度:256 metadata 否 Object 函数扩展属性,由用户自己定制 表6 OperationState 参数 是否必选 参数类型 描述 action_mode 否 String Action执行模式,支持串行,并行两种模式,默认串行 最小长度:1 最大长度:32 枚举值: sequential parallel actions 是 Array of Action objects 节点中要执行的操作列表 on_errors 否 Array of OnError objects 错误处理策略 id 是 String 节点ID,需要在当前函数流中唯一 最小长度:0 最大长度:64 name 是 String 节点名称 最小长度:1 最大长度:256 type 是 String 节点类型 最小长度:1 最大长度:32 枚举值: Operation Sleep End end 是 Boolean 是否是结束节点 transition 是 String 下一步骤节点ID 最小长度:0 最大长度:256 state_data_filter 否 StateDataFilter object 过滤表达式 duration 否 Long 时间等待节点等待时间(秒),节点类型为Sleep时为必填,节点类型不为Sleep时无效 最小值:0.001 最大值:86400 表7 Action 参数 是否必选 参数类型 描述 function_ref 否 FunctionRef object 函数调用信息 表8 FunctionRef 参数 是否必选 参数类型 描述 ref_name 是 String 函数引用名称,需要和外层functions中的name对应 最小长度:0 最大长度:256 invoke_mode 否 String 函数调用模式,目前只支持同步调用 最小长度:1 最大长度:32 枚举值: synchronize asynchronous arguments 是 Object 函数执行时的入参,支持引用constants中的常量 定义方式:参数路径 | 常量值/常量路径 参数路径指输入参数的JsonPath路径,如$.a.b[0].c 常量值可以为数字类型,字符串类型(需要用单引号括起来),布尔类型 常量路径为常量的JsonPath路径,但是根节点需要用$CONST表示,示例:$CONST.a.b 表9 OnError 参数 是否必选 参数类型 描述 error 否 String 错误匹配表达式,用来过滤需要处理的异常 最小长度:0 最大长度:256 transition 否 String 下一步骤节点ID 最小长度:0 最大长度:256 retry_ref 否 String 重试策略名称 最小长度:0 最大长度:256 表10 StateDataFilter 参数 是否必选 参数类型 描述 input 否 String 输入过滤表达式(JsonPath) 最小长度:0 最大长度:256 output 否 String 输出过滤表达式(JsonPath) 最小长度:0 最大长度:256 表11 Retry 参数 是否必选 参数类型 描述 name 是 String 重试策略名称,在单个流程中,名称需要唯一 最小长度:1 最大长度:256 delay 否 Long 重试间隔,单位:秒。若不传,默认为1 最小值:1 最大值:30 max_attempts 否 Long 最大重试次数,。若不传,默认为3 最小值:1 最大值:8 表12 ExpressConfig 参数 是否必选 参数类型 描述 log_level 否 String 快速模式相关配置,仅在mode配置为EXPRESS时生效 快速模式下流程的执行日志级别,当前支持: ALL: 记录所有节点的执行日志 ERROR:仅记录异常节点执行日志 NONE:不记录日志 注意:当配置为ALL和ERROR级别时租户需要开启LTS相关权限 最小长度:1 最大长度:5 枚举值: ALL ERROR NONE
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 execution_id String 错误码 最小长度:1 最大长度:64 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Create-Time 否 String workflowRun task create time X-WorkflowRun-ID 否 String workflowRun id X-WorkflowRun-MergeFnParameters 否 String Combines the output of the previous node with the input of the next node into an input. 表3 请求Body参数 参数 是否必选 参数类型 描述 headers 否 Object 执行时需要的Header input 是 Object 定义执行时的入参,支持使用JSONPATH进行映射,以及指定默认值
共100000条