華為云計(jì)算 云知識(shí) API異步啟動(dòng)工作流AsyncInvokeApiStartWorkflow
API異步啟動(dòng)工作流AsyncInvokeApiStartWorkflow
時(shí)間: 2023-09-06 11:09:45
猜你想看：
實(shí)時(shí)語(yǔ)音識(shí)別 云服務(wù)器配置 CDN是什么意思 視頻點(diǎn)播加速 什么是云桌面

 

接口說(shuō)明

本接口用于API方式異步啟動(dòng)已有工作流,產(chǎn)生工作流實(shí)例

URL
POST  https://dwr.cn-south-1.myhuaweicloud.com/v3/{project_id}/workflows/{graph_name}/execute 
請(qǐng)求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
 string header 是

用戶Token。通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取(響應(yīng)消息頭中X-Subject-Token的值)。
project_id
 
 string path 是

項(xiàng)目ID。
graph_name
 
 string path 是

工作流名稱。
Body參數(shù)
名稱 類型 必選 描述
bucket
 
 string 是

桶名
object
 
 string 是

對(duì)象名
inputs
 
 Input object 否

inputs中的key必須是工作流中的parameter中的名字。
參數(shù)：
inputs
名稱 類型 必選 描述
parameter_name
 
 string 是

輸入?yún)?shù)名稱,由小寫(xiě)字母、數(shù)字和中劃線“-”組成
type
 
 string 是

參數(shù)類型?？蔀閟tring,integer,float,boolean,list,map。type為list類型時(shí),value_type必填
value_type
 
 string 否

當(dāng)列表或map作為輸入項(xiàng)時(shí),其中的元素類型。只支持原子類型。
template_parameter_name
 
 string 否

當(dāng)多個(gè)相同action template在一個(gè)工作流時(shí),增加字段做國(guó)際化。 由小寫(xiě)字母、數(shù)字和中劃線“-”組成
parameter_value
 
 string 否

參數(shù)值。
description
 
 string 否

參數(shù)項(xiàng)描述信息。
default
 
 string 否

默認(rèn)值信息可在創(chuàng)建工作流實(shí)例時(shí)由外部輸入替換;若未填寫(xiě)默認(rèn)值,外部輸入將必須填寫(xiě)這個(gè)參數(shù)的值。 注:默認(rèn)值的類型和定義的參數(shù)類型必須統(tǒng)一。如果出現(xiàn)不一致,解析器可能會(huì)進(jìn)行自動(dòng)轉(zhuǎn)換而導(dǎo)致出現(xiàn)與預(yù)期不符合的情況。
label
 
 string 否

參數(shù)的標(biāo)簽,此處定義的標(biāo)簽可在創(chuàng)建堆棧時(shí)進(jìn)行分類展示。
constraints
 
 constraints object 否

約束條件有以下幾種,一個(gè)輸入?yún)?shù)對(duì)每一種條件都只能定義一個(gè)規(guī)則。約束的多個(gè)條件中只要有一條不滿足,即將認(rèn)定參數(shù)非法。 equal:約定參數(shù)的value值必須等于特定值。 valid_values:參數(shù)的有效值,定義一個(gè)數(shù)組。 regex:參數(shù)需要滿足某個(gè)正則條件,必須是字符串類型才可以進(jìn)行匹配。 invalid_values:參數(shù)的無(wú)效值范圍,如果參數(shù)值定義在其中,將會(huì)認(rèn)為無(wú)效而報(bào)錯(cuò)。
invisible
 
 boolean 否

輸入?yún)?shù)的invisible設(shè)置為true時(shí),返回值為******。
返回參數(shù)
返回碼: 200
 
名稱 類型 必選 描述
Content-Length
 
 string 否

響應(yīng)消息體的字節(jié)長(zhǎng)度。
Connection
 
 string 否

指明與服務(wù)器的連接是長(zhǎng)連接還是短連接。有效值:keep-alive | close。
Date
 
 string 否

OBS系統(tǒng)響應(yīng)的時(shí)間。
x-request-id
 
 string 否

由DWR創(chuàng)建來(lái)唯一確定本次請(qǐng)求的值,可以通過(guò)該值來(lái)定位問(wèn)題。
名稱 類型 必選 描述
execution_urn
 
 string 否

運(yùn)行實(shí)例的URN。
started_at
 
 string 否

運(yùn)行實(shí)例啟動(dòng)時(shí)間。
execution_name
 
 string 否

運(yùn)行實(shí)例的名字。
返回碼: 500
 
名稱 類型 必選 描述
error_msg
 
 string 否

錯(cuò)誤詳細(xì)描述
error_code
 
 integer 否

簡(jiǎn)單錯(cuò)誤碼
request_id
 
 string 否

請(qǐng)求唯一標(biāo)識(shí)ID
請(qǐng)求示例
示例 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
點(diǎn)擊  數(shù)據(jù)工坊  (DWR) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對(duì)應(yīng)語(yǔ)言類型的【使用】目錄下。
錯(cuò)誤碼
請(qǐng)參考 錯(cuò)誤碼說(shuō)明。

 

API異步啟動(dòng)工作流AsyncInvokeApiStartWorkflow

意見(jiàn)反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會(huì)繼續(xù)努力做到更好 反饋提交失敗！請(qǐng)稍后重試！