华为云计算 云知识 API异步启动工作流AsyncInvokeApiStartWorkflow
API异步启动工作流AsyncInvokeApiStartWorkflow

 

接口说明

本接口用于API方式异步启动已有工作流,产生工作流实例

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

用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

project_id
 
string path

项目ID。

graph_name
 
string path

工作流名称。

Body参数
名称 类型 必选 描述
bucket
 
string

桶名

object
 
string

对象名

inputs
 
Input object

inputs中的key必须是工作流中的parameter中的名字。

参数:
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时,返回值为******。

返回参数
返回码: 200
 
名称 类型 必选 描述
Content-Length
 
string

响应消息体的字节长度。

Connection
 
string

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

Date
 
string

OBS系统响应的时间。

x-request-id
 
string

由DWR创建来唯一确定本次请求的值,可以通过该值来定位问题。

名称 类型 必选 描述
execution_urn
 
string

运行实例的URN。

started_at
 
string

运行实例启动时间。

execution_name
 
string

运行实例的名字。

返回码: 500
 
名称 类型 必选 描述
error_msg
 
string

错误详细描述

error_code
 
integer

简单错误码

request_id
 
string

请求唯一标识ID

请求示例
示例 1
 
"/v3/{project_id}/workflows/{graph_name}/execution"
 
"POST/v3/{project_id}/workflows/{graph_name}/execution HTTP/1.1\nHost: dwr.cn-north-4.myhuaweicloud.com\nX-Auth-Token: H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo=\nContent-Type: application/json\nContent-Length: 100\nDate: Thu, 27 Aug 2020 12:38:10 GMT\n\n{\n \"bucket\": \"demo-bucket\",\n \"object\": \"/mpc/demo.mp4\",\n \"inputs\": {\n \"<parameter-name>\": <parameter-value>\n }\n}"
返回示例
返回码:200
 
示例 1
 
{
"execution_urn": "urn:fgs:<region_id>:<project_id>:execution:<graph_name>:<execution_name>:<domain_id>",
"execution_name": "<execution_name>",
"started_at": "2020-04-23T13:37:43.847Z"
}
SDK
点击  数据工坊  (DWR) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明

 

上一篇:删除NamespacedeleteCoreV1Namespace 下一篇:批量删除负载均衡器标签BatchDeleteLoadbalancerTags

华为云开发者中心为开发者提供所有云服务的API及API手册、各产品的SDK、可服务的节点区域和各服务的终端节点EndPoint和在使用华为云产品时需要用到的CLI工具、业务工具等的下载及使用说明。