スケジュール作成
Application Service > Cloud Scheduler > コンソール使用ガイド > スケジュール作成
スケジュールは基本情報、対象情報、追加設定情報で構成されます。
- 基本情報：スケジュール実行のためのタイプ、周期、開始/終了日時を選択します。
- 対象情報：スケジュールが呼び出したAPI情報及びHTTPメソッド、ヘッダ、パラメータを入力します。
- 追加設定：スケジュール有効化/無効化及び再試行ポリシー(回数、間隔)を設定します。
ここでは、スケジュールを作成する手順を詳しく案内します。
スケジュールを作成する
スケジュールを作成するには、まず、Cloud Schedulerサービスを有効にする必要があります。プロジェクトサービス有効化ガイドを参考にしてCloud Schedulerサービスを有効にしてください。
-
NHN CloudコンソールでApplication Service > Cloud Schedulerをクリックしてください。
-
+スケジュール作成をクリックしてください。
-
テンプレートを使用する場合は使用を選択してください。
-
使用したいテンプレートがあれば選択してください。
-
基本情報設定を入力した後、次へをクリックしてください。
-
対象タイプを選択します。対象タイプは直接入力または対象テンプレートを選択することができ、選択したタイプによって入力する項目が異なります。
-
直接入力：対象情報を直接入力します。
* URL:呼び出すURLを入力します。最大255文字まで入力できます。
* HTTPメソッド:ドロップダウンリストをクリックしてHTTPメソッドを選択します。
* HTTPヘッダ: + 追加をクリックしてHTTPヘッダを入力します。 HTTPヘッダは最大20個まで追加することができ、追加した全体ヘッダサイズを合計して最大8KBまで入力できます。
* パラメータ:リクエスト本文を入力します。 HTTPメソッドを POST, PUT, PATCHを選択するとパラメータフィールドが表示されます。入力可能なパラメータサイズは256KBです。
- 対象テンプレート: Cloud Schedulerが提供する対象テンプレートに従って対象情報を入力します。
-
追加設定を完了した後、次へをクリックしてください。
- スケジュール有効化：スケジュールを有効化するかどうかを選択します。
- 再試行ポリシー：スケジュールの実行に失敗した時、再試行するように設定できます。設定を選択すると、再試行間隔と最大再試行回数フィールドが表示されます。
- APIの呼び出しに失敗した場合、設定した再試行ポリシーに従ってスケジュールを再試行します。
* APIの成功基準は、タイムアウト及び結果の検証条件によって異なります。
- 再試行間隔：失敗したスケジュールを再試行する間隔を入力します。最小1分から最大60分まで設定できます。
- 最大再試行回数：最大再試行回数を入力します。最大5回まで設定できます。
- タイムアウト: API呼び出しのタイムアウト時間を入力します。APIの実行時間が設定した時間を超えた場合、その呼び出しは失敗として処理されます。
- 結果no検証: API呼び出しのレスポンスに対する検証基準を設定できます。ユーザー設定を選択すると、結果の検証条件と条件の結合方式フィールドが表示されます。
- 結果の検証条件: 検証タイプ、対象、値、演算子を入力して、結果の検証条件を設定します。最大10個まで追加できます。
- 検証タイプ: 以下のいずれかを選択します。
- HTTP Status Code:レスポンスのHTTPステータスコードを検証します。
- Response Body:レスポンスボディを検証します。
- Response Body(Optional):レスポンスボディを検証します。対象に入力した検証フィールドがレスポンスボディに存在しない場合、「True」として処理されます。
- Header:レスポンスヘッダを検証します。
* 対象: 検証タイプに応じて、検証するフィールドを入力します。最大50文字まで入力できます。
* HTTP Status Code: 入力する対象がないため、無効になります。
* Response Body: JSONPathを入力して、検証するフィールドを指定します。詳細については、以下の例をご参照ください。
* Response Body(Optional): JSONPathを入力して、検証するフィールドを指定します。詳細については、以下の例をご参照ください。
- Header:検証するヘッダ名を入力します。
* 値: 検証する対象の値を入力します。最大20文字まで入力できます。HTTP Status Codeを検証する場合、入力可能な範囲は100～599です。
* 演算子: 結果の検証時に使用する演算子を選択します。
* 条件の結合方式: 複数の検証条件を組み合わせる際の方式を選択します。
* 全ての条件に一致: 全ての条件が「True」の場合、結果を成功として処理します。
- いずれかの条件に一致: 1つでも「True」の条件がある場合、結果を成功として処理します。
Response Body(Optionalを含む) JSONPathの対象入力例
{
"firstName": "NHN",
"lastName" : "Cloud",
"phoneNumbers": [
{
"type" : "iPhone",
"number": "0123-4567-8888"
},
{
"type" : "galaxy",
"number": "0123-4567-8910"
}
]
}
* 上記のレスポンスボディのfirstNameフィールドを検証する場合 JSONPath: $.firstName
* 上記のレスポンスボディのphoneNumbersフィールドの2番目のオブジェクトのtypeフィールドを検証する場合 JSONPath: $.phoneNumbers[1].type
* JSONPath 公式ガイド
- 最終確認と保存段階で設定した情報を確認してからスケジュール作成をクリックしてください。
参考情報
- テンプレート機能を利用して、あらかじめ設定しておいた情報を素早く入力できます。 テンプレート管理を参照してください。
- Cron式は5つのフィールドで作成し、フィールドは順番に「分、時、日、月、曜日」です。
- スムーズなスケジュール実行のために、開始日時を現在時刻より 5分以上余裕を持って設定してください。
- 作成したスケジュールが反映されるまでに最大30秒かかる場合があります。そのため、その間、有効化/無効化を含むスケジュール内容の変更に失敗する可能性があります。
注意
- Cron式は韓国標準時(UTC+09:00)基準で動作します。例えば、 '0 9 * * *'と入力すると、毎日韓国時間で午前9時に作業が実行されます。
- 繰り返しタイプをRateに選択した場合、スケジュール実行は開始日時とRate値によって変更されることがあります。Rateスケジュールの作動方式およびスケジュール実行例を参考に正しく設定してください。
Rateスケジュールの作動方式
Rateスケジュールは、設定した時間間隔に 従ってスケジュール実行します。
ここではRateスケジュールの作動方式を説明します。
- 初回開始日時：Rateスケジュールが最初に開始される日付は、ユーザーが設定した開始日時です。
- スケジュール実行時間：Rateスケジュールの実行時間は、開始日時を基準にユーザーが設定したRate間隔ごとに実行されます。これは無効化後、有効にした場合も同様に適用されます。
- Rate変更時：Rateが変更されると、変更されたRate間隔に従ってスケジュールが実行されます。ただし、直前の実行時間に関係なく、開始日時を基準に変更されたRate間隔で実行されます。
スケジュール実行例
スケジュールが実行される時刻は、設定した開始日時と終了日時、そしてどのようなスケジュールタイプで入力したかによって異なります。
ここでは、ユーザーの理解を助けるために、同じ開始日時と終了日時の場合、Cron、Rateスケジュールタイプでのスケジュール実行例を示します。
!!! tip 「参考情報」
スケジュール実行例の日付データは韓国標準時(UTC+09:00)基準です。
- 開始日時：2024-01-05 00:00:00
- 終了日時：2024-01-08 01:00:00
- Cronスケジュールの場合
- Cron式：0 12 * * * (毎日昼12時実行)
- 最初のスケジュール実行時間
- 最後のスケジュール実行時間
- Rateスケジュールの場合
- 一般的な状況
* Rate：12時間ごとに実行
* 最初のスケジュール実行時間
* 2024-01-05 00:00:00
* 最後のスケジュール実行時間
* 2024-01-08 00:00:00
- スケジュールを無効にした後、有効にする
- Rate：3時間ごとに実行
- 1次実行
- 2次実行
- スケジュール無効化
- スケジュール有効化
- 3次実行
- 4次実行
- Rate変更
- Rate：3時間ごとに実行
- 1次実行
- 2次実行
- Rate：4時間ごとの実行に変更
- 3次実行
- 4次実行