createTrigger

VPC環境で利用できます。

トリガーを作成します。

リクエスト

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

メソッド	URI
POST	/api/v1/triggers

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Required	ジョブ名英数字、記号の「_」、「-」を組み合わせて3~100文字以内で入力先頭文字は英字または「_」のみ使用
`type`	String	Required	トリガータイプ `SCHEDULED` \| `EVENT` \| `NONE` `SCHEDULED`: 周期または特定日実行 `EVENT`: 特定のイベント発生時に実行(今後サポート予定) `NONE`: トリガーを設定しない(手動実行)
`triggerRule`	Object	Required	トリガーの実行オプション
`triggerRule.type`	String	Required	トリガーの実行オプションタイプ `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: 周期実行 `ONE_TIME`: 特定日実行 `NONE`: 実行オプションなし
`triggerRule.interval`	String	Conditional	トリガーの実行周期 `HOUR` \| `DAY` \| `WEEK` \| `MONTH` `HOUR`: 毎時 `DAY`: 毎日 `WEEK`: 毎週 `MONTH`: 毎月 `triggerRule.type`が`RECURRING`の場合、必ず入力
`triggerRule.time`	String	Conditional	トリガーの繰り返し実行時間(分または時刻) `triggerRule.type`が`RECURRING`の場合、必ず入力 `triggerRule.interval`が`HOUR`の場合、繰り返す分を表示(00~59) `triggerRule.interval`が`DAY`、`WEEK`、`MONTH`の場合、繰り返す時刻を表示
`triggerRule.dayOfWeek[]`	Array	Conditional	トリガーの繰り返し実行曜日 `MONDAY` \| `TUESDAY` \| `WEDNESDAY` \| `THURSDAY` \| `FRIDAY` \| `SATURDAY` \| `SUNDAY` `triggerRule.interval`が`WEEK`の場合、必ず入力
`triggerRule.dateOfMonth`	String	Conditional	トリガーの繰り返し実行日 1~31の間の日付、-1(毎月末日) `triggerRule.interval`が`MONTH`の場合、必ず入力
`triggerRule.executionDate`	String	Conditional	トリガーの実行日時 `triggerRule.type`が`ONE_TIME`の場合、必ず入力

リクエスト例

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

curl --location --request POST 'https://dataflow.apigw.ntruss.com/api/v1/triggers' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "name": "trigger001",
  "type": "SCHEDULED",
  "triggerRule": {
    "type": "RECURRING",
    "interval": "DAY",
    "time": "10:00"
  }
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`triggerId`	String	-	トリガー ID
`name`	String	-	トリガー名
`type`	String	-	トリガーの実行オプション `SCHEDULED` \| `NONE` `SCHEDULED`: 周期または特定日実行 `NONE`: 実行オプションなし
`triggerRule`	Object	-	トリガーの実行オプション情報
`triggerRule.type`	String	-	トリガーの実行オプションタイプ `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: 周期実行 `ONE_TIME`: 特定日実行 `NONE`: 実行オプションなし
`triggerRule.interval`	String	-	トリガーの実行周期 `HOUR` \| `DAY` \| `WEEK` \| `MONTH` `HOUR`: 毎時 `DAY`: 毎日 `WEEK`: 毎週 `MONTH`: 毎月 `triggerRule.type`が`RECURRING`の場合、表示
`triggerRule.time`	String	-	トリガーの繰り返し実行時間(分または時刻) `triggerRule.type`が`RECURRING`の場合、表示 `triggerRule.interval`が`HOUR`の場合、繰り返す分を表示(00~59) `triggerRule.interval`が`DAY`、`WEEK`、`MONTH`の場合、繰り返す時刻を表示
`triggerRule.dayOfWeek[]`	Array	-	トリガーの繰り返し実行曜日 `MONDAY` \| `TUESDAY` \| `WEDNESDAY` \| `THURSDAY` \| `FRIDAY` \| `SATURDAY` \| `SUNDAY` `triggerRule.interval`が`WEEK`の場合、表示
`triggerRule.dateOfMonth`	String	-	トリガーの繰り返し実行日 1~31の間の日付、-1(毎月末日) `triggerRule.interval`が`MONTH`の場合、表示
`triggerRule.executionDate`	String	-	トリガーの実行日時 `triggerRule.type`が`ONE_TIME`の場合、表示
`createdDate`	String	-	トリガーの作成日時 ISO 8601形式(UTC+9を含む)
`updatedDate`	String	-	トリガーの更新日時 ISO 8601形式(UTC+9を含む)

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

Data Flow APIで共通して使用されるレスポンスステータスコードの詳細は、Data Flow APIのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "triggerId": "rWOjcW******",
    "name": "trigger1",
    "type": "SCHEDULED",
    "triggerRule": {
        "type": "RECURRING",
        "interval": "DAY",
        "time": "10:00"
    },
    "createdDate": "2025-03-21T15:26:51+09:00",
    "updatedDate": "2025-03-21T15:26:51+09:00"
}