华为云计算 云知识 创建工作流CreateWorkflow

新客秒杀 2核2G 3M L实例

68元/年

普惠上云 领千元上云礼券

立即前往

企业专享 X实例 4核8G 5M

888元/年

热门域名 1元 随心购

1元/年起

创建工作流CreateWorkflow
时间: 2023-09-06 10:29:30
API网关 云计算
猜你想看：
实时语音识别 云服务器配置 CDN是什么意思 视频点播加速 什么是云桌面

 

接口说明

本接口用于通过Body体直接创建工作流

URL
POST  https://dwr.cn-south-1.myhuaweicloud.com/v3/{project_id}/workflows/{graph_name} 
请求参数
名称 类型 IN 必选 描述
X-Auth-Token
 
 string header 是

用户Token。通过调用 IAM 服务获取用户Token接口获取(相应消息头中X-Subject-Token的值)。 条件:匿名请求不需要带,其他请求必选。
project_id
 
 string path 是

项目ID。
graph_name
 
 string path 是

工作流名称。名称必须以字母或数字开头,只能由字母、数字、下划线和中划线组成,长度小于等于64个字符,且不能重名
Body参数
名称 类型 必选 描述
states
 
 Array of State objects 否

工作流的编排定义,必须有TYPE,TYPE值必须是3种State(DELAY,OPERATION,END)中一种。每个state的名字是1-80长度的只含数字,字母,-和_的String。
inputs
 
 Array of Input objects 否

工作流中用户可修改的参数项
description
 
 string 否

工作流的描述
mode
 
 string 否

工作流执行类型:同步(EXPRESS)、异步(NORMAL)
express_config
 
 ExpressConfig object 否

同步工作流的日志记录模式,默认ERROR。 ALL: 记录所有节点的执行日志 ERROR:仅记录异常节点执行日志 NONE:不记录日志 注意:当配置为ALL和ERROR级别时租户需要开启 LTS 相关权限
func_vpc
 
 FuncVpc object 否

工作流在指定vpc下执行
agency
 
 string 否

用戶传入用于创建工作流时使用的委托的委托名
参数：
states
名称 类型 必选 描述
start
 
 boolean 否

标识开始的state,图中必须且只有一个start为true的state。
type
 
 string 是

必须有TYPE,TYPE值必须是3种State(DELAY,OPERATION,END)中一种。
payload_filter_in
 
 string 否

过滤输入参数,默认值是"$",表示不过滤。必须是合法的JSONPath格式。 说明 END State没有payload_filter_in属性。
payload_filter_out
 
 string 否

过滤state的输出结果,默认值是"$",表示不过滤。 必须是合法的JSONPath格式。 说明 END State没有payload_filter_out属性。
state_name
 
 string 是

state的名字定义。 由小写字母、数字和中划线“-”组成,长度为[1, 20]。
action_mode
 
 string 否

Action执行模式,支持串行,并行两种模式,默认串行

最小长度:1

最大长度:32

枚举值:

sequential

parallel
actions
 
 Array of Action objects 否

节点中要执行的操作列表
next_state
 
 string 否

创建工作流指定的下一个节点名称
time_delay
 
 integer 否

当节点类型为事件延迟时填入需要延迟的时间,单位为秒
参数：
states.actions
名称 类型 必选 描述
action_name
 
 string 是

节点名称
action_agency
 
 string 是

节点使用的委托
function
 
 string 是

节点相关联的函数URN
function_template
 
 string 是

算子模板使用的URM
action_template_name
 
 string 否

节点使用的算子名称
action_template_category
 
 string 否

节点使用的模板类别
action_template_provider_name
 
 string 否

节点使用的模板提供方
invocation_mode
 
 string 是

触发模式
timeout
 
 integer 是

超时时间
payload_filter
 
 string 否

动态参数与inputs参数相关联使用的filter。默认为"$"
dynamic_source
 
 Map<String,Object> 是

节点使用的动态参数
results
 
 Array of ActionResult objects 否

action错误处理
参数：
states.actions.results
名称 类型 必选 描述
match
 
 string 是

触发错误处理需符合的条件
retry_interval
 
 integer 是

每次重试间隔时间
max_retry
 
 integer 否

最多重试次数
next_state
 
 string 是

下一个状态
is_terminal
 
 boolean 否

是否为结束状态
参数：
inputs
名称 类型 必选 描述
parameter_name
 
 string 是

输入参数名称,由小写字母、数字和中划线“-”组成
type
 
 string 是

参数类型。可为string,integer,float,boolean,list,map。type为list类型时,value_type必填
value_type
 
 string 否

当列表或map作为输入项时,其中的元素类型。只支持原子类型。
template_parameter_name
 
 string 否

当多个相同action template在一个工作流时,增加字段做国际化。 由小写字母、数字和中划线“-”组成
parameter_value
 
 string 否

参数值。
description
 
 string 否

参数项描述信息。
default
 
 string 否

默认值信息可在创建工作流实例时由外部输入替换;若未填写默认值,外部输入将必须填写这个参数的值。 注:默认值的类型和定义的参数类型必须统一。如果出现不一致,解析器可能会进行自动转换而导致出现与预期不符合的情况。
label
 
 string 否

参数的标签,此处定义的标签可在创建堆栈时进行分类展示。
constraints
 
 constraints object 否

约束条件有以下几种,一个输入参数对每一种条件都只能定义一个规则。约束的多个条件中只要有一条不满足,即将认定参数非法。 equal:约定参数的value值必须等于特定值。 valid_values:参数的有效值,定义一个数组。 regex:参数需要满足某个正则条件,必须是字符串类型才可以进行匹配。 invalid_values:参数的无效值范围,如果参数值定义在其中,将会认为无效而报错。
invisible
 
 boolean 否

输入参数的invisible设置为true时,返回值为******。
参数：
express_config
名称 类型 必选 描述
log_level
 
 string 否

同步工作流执行时记录LTS的日志级别,NONE、ERROR\ALL,默认NONE
support_anonymous
 
 boolean 否

同步工作流是否支持匿名访问
参数：
func_vpc
名称 类型 必选 描述
subnet_id
 
 string 否

子网编号。当func_vpc非空时必选。
vpc_id
 
 string 否

虚拟私有云 唯一标识。当func_vpc非空时必选。
vpc_name
 
 string 否

VPC名称。
subnet_name
 
 string 否

子网名称。
cidr
 
 string 否

子网掩码。
gateway
 
 string 否

网关。
返回参数
返回码: 200

工作流创建结果信息

名称 类型 必选 描述
Content-Length
 
 string 否

响应消息体的字节长度。
Connection
 
 string 否

指明与服务器的连接是长连接还是短连接。有效值:keep-alive | close。
Date
 
 string 否

DWR系统响应的时间。
x-request-id
 
 string 否

由DWR创建来唯一确定本次请求的值,可以通过该值来定位问题。
名称 类型 必选 描述
graph_name
 
 string 否

工作流名称。
graph_urn
 
 string 否

工作流的URN。
created_at
 
 string 否

工作流创建的时间。
返回码: 400
 
名称 类型 必选 描述
error_msg
 
 string 否

错误详细描述
error_code
 
 integer 否

简单错误码
request_id
 
 string 否

请求唯一标识ID
返回码: 401
 
名称 类型 必选 描述
error_msg
 
 string 否

错误详细描述
error_code
 
 integer 否

简单错误码
request_id
 
 string 否

请求唯一标识ID
返回码: 403
 
名称 类型 必选 描述
error_msg
 
 string 否

错误详细描述
error_code
 
 integer 否

简单错误码
request_id
 
 string 否

请求唯一标识ID
返回码: 500
 
名称 类型 必选 描述
error_msg
 
 string 否

错误详细描述
error_code
 
 integer 否

简单错误码
request_id
 
 string 否

请求唯一标识ID
请求示例
示例 1
 
"/v3/{project_id}/workflows/{graph_name}?x_workflow_create"
 
{ "inputs": [ { "parameter_name": "jpeg_comp_bkt", "parameter_value": "oef-test-ymx", "value_type": "", "default": "", "type": "string", "label": "Body", "constraints": { "regex": ".*" }, "invisible": false, "description": "jpeg compress output bucket", "dynamic_source_path": "", "template_parameter_name": "jpeg_comp_bkt", "paramId": "jpeg_comp_bkt" }, { "parameter_name": "jpeg_comp_path", "parameter_value": "output/", "value_type": "", "default": "output/", "type": "string", "label": "Body", "constraints": { "regex": ".*" }, "invisible": false, "description": "jpeg compress output path", "dynamic_source_path": "", "template_parameter_name": "jpeg_comp_path", "paramId": "jpeg_comp_path" }, { "parameter_name": "jpeg_comp_overwrite", "parameter_value": "false", "value_type": "", "default": "false", "type": "boolean", "label": "Body", "constraints": { "valid_values": [ "true", "false" ] }, "invisible": false, "description": "jpeg compress output overwrite destination", "dynamic_source_path": "", "template_parameter_name": "jpeg_comp_overwrite", "paramId": "jpeg_comp_overwrite" } ], "states": [ { "state_name": "End", "type": "END" }, { "state_name": "JPEGCompress", "payload_filter_in": "$", "payload_filter_out": "$", "type": "OPERATION", "action_mode": "SEQUENTIAL", "actions": [ { "action_template_name": "JPEGCompress", "action_name": "JPEGCompress", "action_template_category": "FileProcess", "action_template_provider_name": "op_svc_obs", "invocation_mode": "SYNC", "timeout": 30, "payload_filter": "$", "results": [], "dynamic_source": { "param": { "input": { "bucket": "obs-oef-workflow", "isoverride": { "get_input": "$.inputs.jpeg_comp_overwrite" }, "location": "cn-north-7", "object": "config.jpeg" }, "output": { "bucket": { "get_input": "$.inputs.jpeg_comp_bkt" }, "location": "cn-north-7", "object": { "get_input": "$.inputs.jpeg_comp_path" } } } }, "function_template": "urn:fss:cn-north-7:c5ca145430464de88518b2ce0f21f903:function:default:oef-funcube-jpeg-compress-1x:latest" } ], "next_state": "End", "start": true } ], "description": "description" }
返回示例
返回码：200

工作流创建结果信息

示例 1
 
{
"graph_name": "test-graph",
"graph_urn": "urn:obs:cn-north-5:3f1e6caf808246c68457e660e4bfeb2f:graph:test-graph",
"created_at": "2020-04-23T12:32:11.131Z"
}
SDK
点击  数据工坊  (DWR) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明。

 

上一篇：华为云黑洞策略是什么 下一篇：镜像服务
免费使用基础版免费使用
购买 控制台 文档

猜你喜欢

最新文章

人脸识别0元领取 | 免费体验云产品
创建工作流CreateWorkflow

您找到想要的内容了吗?

是的 没有

意见反馈

0/200

提交 取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好 反馈提交失败！请稍后重试！
产品专区
相关专题

更多内容

华为云服务 商标注册流程及费用 免费网站申请域名 Manjaro镜像下载 域名是什么 怎么制作一个网站 Email注册网站 新用户优惠 华为折扣券哪里领 云服务器代金券
文字识别平台 NPM镜像下载
展开全部收起全部