云工作流(CloudFlow)采用RPC風格API,支持GET和POST請求方式。本文提供了調用云工作流API的方法,一次API請求中,會涉及簽名、參數設定以及身份驗證等設置。
請求結構
此章節講解HTTP/HTTPS調用場景中,一次API的請求的結構分析。
以下是GET請求的URL格式,字符編碼采用UTF-8規范。
http(s)://Endpoint/?Action=xx&Parameters
Endpoint:調用的云服務的接入點。
Action:當前請求需要執行的操作,例如使用StartExecution執行一個流程。
Parameters:代指請求參數,由公共請求參數和API自定義參數組成,參數之間使用“&”分隔。
以下是StartExecution接口的請求示例:
https://[Endpoint]/?Action=StartExecution
&FlowName=Flow
&公共請求參數
為了獲得更高的安全性,建議您使用HTTPS協議發送API請求。
服務接入地址
云工作流API的服務接入地址為:XXX.aliyuncs.com。
地域 | 公網服務接入地址 | VPC服務接入地址 | 經典網絡服務接入地址 |
華東1(杭州) | cn-hangzhou.fnf.aliyuncs.com | cn-hangzhou-internal.fnf.aliyuncs.com | cn-hangzhou-classic.fnf.aliyuncs.com |
華東2(上海) | cn-shanghai.fnf.aliyuncs.com | cn-shanghai-internal.fnf.aliyuncs.com | cn-shanghai-classic.fnf.aliyuncs.com |
華北2(北京) | cn-beijing.fnf.aliyuncs.com | cn-beijing-internal.fnf.aliyuncs.com | cn-beijing-classic.fnf.aliyuncs.com |
華北1(青島) | cn-qingdao.fnf.aliyuncs.com | cn-qingdao-internal.fnf.aliyuncs.com | cn-qingdao-classic.fnf.aliyuncs.com |
華南1(深圳) | cn-shenzhen.fnf.aliyuncs.com | cn-shenzhen-internal.fnf.aliyuncs.com | cn-shenzhen-classic.fnf.aliyuncs.com |
新加坡 | ap-southeast-1.fnf.aliyuncs.com | ap-southeast-1-internal.fnf.aliyuncs.com | ap-southeast-1-classic.fnf.aliyuncs.com |
美國(硅谷) | us-west-1.fnf.aliyuncs.com | us-west-1-internal.fnf.aliyuncs.com | us-west-1-classic.fnf.aliyuncs.com |
公共參數
以下公共請求參數適用于通過URL發送GET請求調用云工作流API。
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Action | String | 是 | StartExecution | API的名稱。 |
AccessKeyId | String | 是 | LTAIp4********fjx | 訪問密鑰ID。更多詳情,請參見創建AccessKey。 |
Signature | String | 是 | OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D | 您的簽名。更多詳情,請參見簽名機制。 |
SignatureMethod | String | 是 | HMAC-SHA1 | 簽名方式。默認簽名方式:HMAC-SHA1。 |
SignatureVersion | String | 是 | 1.0 | 簽名算法版本。默認版本:1.0。 |
SignatureNonce | String | 是 | 3ee8c1b8-****-44af-****-4e0ad82fd6cf | 簽名唯一隨機數。用于防止網絡重放攻擊,建議您每一次請求都使用不同的隨機數。 |
Timestamp | String | 是 | 2024-01-01T12:00:00Z | 請求的時間戳。按照ISO8601標準表示,并使用UTC+0時間,格式為yyyy-MM-ddTHH:mm:ssZ。 |
Version | String | 是 | 2019-03-15 | API的版本號,格式為YYYY-MM-DD。默認API的版本號:2019-03-15。 |
Format | String | 否 | json | 返回參數的語言類型。語言類型為JSON或XML格式。默認的語言類型:JSON。 |