GET /api/job_invocations
列出工作祈願

參數

參數名字 描述
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
顯示工作祈願

參數

參數名字 描述
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
建立工作祈願

參數

參數名字 描述
job_invocation
必填

Validations:

  • Must be a Hash

job_invocation[job_template_id]
必填

要使用的工作範本

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]
選填 , 允許空值

要使用的輸入

Validations:

  • Must be a Hash

job_invocation[ssh]
選填 , 允許空值

SSH 供應者特定選項

Validations:

  • Must be a Hash

job_invocation[ssh][effective_user]
選填 , 允許空值

哪位使用者該用來執行此 script(使用類似 sudo 機制)。預設值設為範本參數或全域設定。

Validations:

  • Must be a String

job_invocation[recurrence]
選填 , 允許空值

建立週期性工作

Validations:

  • Must be a Hash

job_invocation[recurrence][cron_line]
選填 , 允許空值

工作多常發生,格式同 cron

Validations:

  • Must be a String

job_invocation[recurrence][max_iteration]
選填 , 允許空值

重複最多 N 次

Validations:

  • Must be a number.

job_invocation[recurrence][end_time]
選填 , 允許空值

此時間之後不再進行任何執行

Validations:

  • Must be a DateTime

job_invocation[scheduling]
選填 , 允許空值

排程工作至晚一點的時間

Validations:

  • Must be a Hash

job_invocation[scheduling][start_at]
選填 , 允許空值

排程工作至未來時間

Validations:

  • Must be a DateTime

job_invocation[scheduling][start_before]
選填 , 允許空值

這表示如果不能在這時間之前開始,就應該取消動作。

Validations:

  • Must be a DateTime

job_invocation[concurrency_control]
選填 , 允許空值

隨時間控制週期等級並散佈

Validations:

  • Must be a Hash

job_invocation[concurrency_control][time_span]
選填 , 允許空值

在幾秒間散佈工作

Validations:

  • Must be a Integer

job_invocation[concurrency_control][concurrency_level]
選填 , 允許空值

一次最多執行 N 個任務

Validations:

  • Must be a Integer

job_invocation[bookmark_id]
選填 , 允許空值

Validations:

  • Must be a Integer

job_invocation[search_query]
選填 , 允許空值

Validations:

  • Must be a Integer

job_invocation[description_format]
選填 , 允許空值

僅為這祈願從範本覆寫描述格式

Validations:

  • Must be a String


GET /api/job_invocations/:id/hosts/:host_id
取得主機輸出

參數

參數名字 描述
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