CloudFlow は RPC プロトコルを使用します。HTTP GET または POST リクエストを CloudFlow エンドポイントに送信することで、API オペレーションを呼び出すことができます。各リクエストには、必須パラメーターと認証用の有効な署名を含める必要があります。
リクエスト構文
GET リクエストでは、以下の URL 形式を使用します。URL は UTF-8 でエンコードしてください。
http(s)://エンドポイント/?Action=xx&パラメーター-
エンドポイント：ご利用のリージョン向けの CloudFlow API エンドポイントです。「エンドポイント」をご参照ください。
-
Action：実行する API オペレーションです。たとえば、ワークフロー実行を開始する場合は、
Actionを StartExecution に設定します。 -
パラメーター：アンパサンド (
&) で区切られたリクエストパラメーターです。共通パラメーター およびオペレーション固有のパラメーターを含めてください。
例：StartExecution オペレーションを呼び出す場合：
https://<エンドポイント>/?Action=StartExecution
&FlowName=Flow
&<共通リクエストパラメーター>セキュリティのため、API リクエストは HTTPS 経由で送信してください。
エンドポイント
CloudFlow API エンドポイントは、{region-id}.fnf.aliyuncs.com の形式に従います。
|
リージョン |
パブリックエンドポイント |
VPC エンドポイント |
クラシックネットワークエンドポイント |
|
中国 (杭州) |
cn-hangzhou.fnf.aliyuncs.com |
cn-hangzhou-internal.fnf.aliyuncs.com |
cn-hangzhou-classic.fnf.aliyuncs.com |
|
中国 (上海) |
cn-shanghai.fnf.aliyuncs.com |
cn-shanghai-internal.fnf.aliyuncs.com |
cn-shanghai-classic.fnf.aliyuncs.com |
|
中国 (北京) |
cn-beijing.fnf.aliyuncs.com |
cn-beijing-internal.fnf.aliyuncs.com |
cn-beijing-classic.fnf.aliyuncs.com |
|
中国 (青島) |
cn-qingdao.fnf.aliyuncs.com |
cn-qingdao-internal.fnf.aliyuncs.com |
cn-qingdao-classic.fnf.aliyuncs.com |
|
中国 (深セン) |
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 |
共通パラメーター
CloudFlow API エンドポイントへのすべての GET リクエストには、以下のパラメーターを含めてください。
|
パラメーター |
型 |
必須 |
例 |
説明 |
|
Action |
String |
はい |
StartExecution |
実行する API オペレーションです。 |
|
AccessKeyId |
String |
はい |
yourAccessKeyID |
Alibaba Cloud の AccessKey ID です。詳細については、「AccessKey ペアの取得」をご参照ください。 |
|
Signature |
String |
はい |
OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D |
リクエスト署名です。詳細については、「リクエスト構文および署名方式 V3」をご参照ください。 |
|
SignatureMethod |
String |
はい |
HMAC-SHA1 |
署名暗号化アルゴリズムです。デフォルト値：HMAC-SHA1。 |
|
SignatureVersion |
String |
はい |
1.0 |
署名アルゴリズムのバージョンです。デフォルト値：1.0。 |
|
SignatureNonce |
String |
はい |
3ee8c1b8-****-44af-****-4e0ad82fd6cf |
リプレイ攻撃を防止するための一意のランダム値です。各リクエストで異なる値を使用してください。 |
|
Timestamp |
String |
はい |
2024-01-01T12:00:00Z |
ISO 8601 形式のリクエストタイムスタンプ（UTC）： |
|
Version |
String |
はい |
2019-03-15 |
|
|
Format |
String |
いいえ |
json |
応答フォーマットです。有効な値：JSON、XML。デフォルト値：JSON。 |