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

Params

Param Name Description
search
Optional

結果のフィルター

Validations:

  • Must be String

order
Optional

結果のソート

Validations:

  • Must be String

page
Optional

結果のページネーション

Validations:

  • Must be String

per_page
Optional

要求ごとのエントリー数

Validations:

  • Must be String


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

Params

Param Name Description
id
Required

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
ジョブ呼び出しを作成

Params

Param Name Description
job_invocation
Required

Validations:

  • Must be a Hash

job_invocation[job_template_id]
Required

使用するジョブテンプレート

Validations:

  • Must be String

job_invocation[targeting_type]
Required

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

Validations:

  • Must be String

job_invocation[inputs]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

使用する入力

Validations:

  • Must be Hash

job_invocation[ssh]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a Hash

job_invocation[ssh][effective_user]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

job_invocation[recurrence]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

繰り返しジョブを作成

Validations:

  • Must be a Hash

job_invocation[recurrence][cron_line]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

job_invocation[recurrence][max_iteration]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

最大 N 回繰り返す

Validations:

  • Must be a number.

job_invocation[recurrence][end_time]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

これ以降実行しない

Validations:

  • Must be DateTime

job_invocation[scheduling]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a Hash

job_invocation[scheduling][start_at]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be DateTime

job_invocation[scheduling][start_before]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be DateTime

job_invocation[concurrency_control]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a Hash

job_invocation[concurrency_control][time_span]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be Integer

job_invocation[concurrency_control][concurrency_level]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be Integer

job_invocation[bookmark_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be Integer

job_invocation[search_query]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be Integer

job_invocation[description_format]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

job_invocation[execution_timeout_interval]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Override the timeout interval from the template for this invocation only

Validations:

  • Must be Integer


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

Params

Param Name Description
id
Required

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
Required

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
Optional

Validations:

  • Must be String