executeWorkflow

Prev Next

VPC環境で利用できます。

ワークフローを実行します。

ワークフローは、開始トリガーの実行オプションが直接実行またはイベントの場合にのみ実行できます。実行リクエストの受付まで確認してレスポンスし、実行結果はgetWorkflowExecutionsで確認します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/workflows/{workflowId}/executions

リクエストヘッダ

Data Flow APIで共通して使用されるヘッダの詳細は、Data Flowのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
workflowId String Required ワークフロー ID

リクエストボディ

リクエストボディは使用しません。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://dataflow.apigw.ntruss.com/api/v1/workflows/3tfNLP******/executions' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
workflowId String - ワークフロー ID
triggerId String - 実行された開始トリガー ID
status String - 実行リクエスト受信状態
  • ACCEPTED
    • ACCEPTED: 実行リクエスト受付完了

レスポンスステータスコード

Data Flow APIで共通して使用するレスポンスステータスは、Data Flowのレスポンスステータスコードをご参照ください。リクエストが正常に受付されると、202のステータスコードを返します。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "workflowId": "3tfNLP******",
    "triggerId": "8bjF7E******",
    "status": "ACCEPTED"
}