ジョブ・テンプレートの起動
get
/api/v2/system_job_templates/{id}/launch/
このリソースに対してPOSTリクエストを行って、システム・ジョブ・テンプレートを起動します。
パラメータextra_vars内で指定された変数は、システム・ジョブ・タスクにコマンドライン・パラメータとして渡されます。 これらのタスクは、ホスト・システムでawx-manageコマンドを使用して手動で実行できます。
たとえば、cleanup_jobsおよびcleanup_activitystreamの場合:
{"extra_vars": {"days": 30}}
30日より前のデータに作用します。
cleanup_activitystreamコマンドおよびcleanup_jobsコマンドの場合、extra_vars内に"dry_run": trueを指定すると、アイテムが削除されることなく、削除対象のアイテムが表示されます。
個々のシステム・ジョブ・タスクにはそれぞれ独自のデフォルト値があります。これは、コマンドラインから実行するとき、または空のextra_varsを使用してシステム・ジョブ・テンプレートを起動するときに適用されます。
cleanup_activitystreamのデフォルト: days=90cleanup_jobsのデフォルト: days=90
成功した場合、レスポンス・ステータス・コードは202になります。 ジョブを起動できない場合は、405ステータス・コードが返されます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- page(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。