GET /api/job_invocations
ジョブ呼び出しを一覧表示

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

結果のソート

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


GET /api/job_invocations/:id
ジョブ呼び出しを表示

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/job_invocations
ジョブ呼び出しを作成

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

job_invocation
必須

Validations:

  • Must be a Hash

job_invocation[job_template_id]
任意 , nil可

The job template to use, parameter is required unless feature was specified

Validations:

  • Must be a String

job_invocation[targeting_type]
必須

Invocation type, one of {“static_query”=>“Static Query”, “dynamic_query”=>“Dynamic Query”}

Validations:

  • Must be a String

job_invocation[inputs]
任意 , nil可

使用する入力

Validations:

  • Must be a Hash

job_invocation[ssh]
任意 , nil可

SSH プロバイダー固有オプション

Validations:

  • Must be a Hash

job_invocation[ssh][effective_user]
任意 , nil可

スクリプトを実行するために使用するユーザー (sudo と同様のメカニズムを使用)。デフォルト値は、テンプレートパラメーターまたはグローバル設定です。

Validations:

  • Must be a String

job_invocation[recurrence]
任意 , nil可

繰り返しジョブを作成

Validations:

  • Must be a Hash

job_invocation[recurrence][cron_line]
任意 , nil可

ジョブを実行する頻度 (cron 形式)

Validations:

  • Must be a String

job_invocation[recurrence][max_iteration]
任意 , nil可

最大 N 回繰り返す

Validations:

  • Must be a number.

job_invocation[recurrence][end_time]
任意 , nil可

これ以降実行しない

Validations:

  • Must be a DateTime

job_invocation[scheduling]
任意 , nil可

後で開始するジョブをスケジュール

Validations:

  • Must be a Hash

job_invocation[scheduling][start_at]
任意 , nil可

将来のジョブをスケジュール

Validations:

  • Must be a DateTime

job_invocation[scheduling][start_before]
任意 , nil可

アクションはこの時刻よりも前に開始できない場合にキャンセルされることを示しています。

Validations:

  • Must be a DateTime

job_invocation[concurrency_control]
任意 , nil可

同時実行レベルと分散を制御

Validations:

  • Must be a Hash

job_invocation[concurrency_control][time_span]
任意 , nil可

N 秒間にわたってタスクを分散

Validations:

  • Must be a Integer

job_invocation[concurrency_control][concurrency_level]
任意 , nil可

一度に最大 N タスクを実行

Validations:

  • Must be a Integer

job_invocation[bookmark_id]
任意 , nil可

Validations:

  • Must be a Integer

job_invocation[search_query]
任意 , nil可

Validations:

  • Must be a String

job_invocation[description_format]
任意 , nil可

この呼び出しに対してのみテンプレートから説明形式を上書き

Validations:

  • Must be a String

job_invocation[execution_timeout_interval]
任意 , nil可

Override the timeout interval from the template for this invocation only

Validations:

  • Must be a Integer

job_invocation[feature]
任意 , nil可

Remote execution feature label that should be triggered, job template assigned to this feature will be used

Validations:

  • Must be a String


GET /api/job_invocations/:id/hosts/:host_id
ホストの出力を取得

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

host_id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

since
任意

Validations:

  • Must be a String


POST /api/job_invocations/:id/cancel
Cancel job invocation

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

force
任意

Validations:

  • Must be one of: true, false, 1, 0


POST /api/job_invocations/:id/rerun
Rerun job on failed hosts

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

failed_only
任意

Validations:

  • Must be one of: true, false, 1, 0