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 разрешен

Количество повторений

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 разрешен

Распределить задачи в пределах заданного периода времени (в секундах)

Validations:

  • Must be a Integer

job_invocation[concurrency_control][concurrency_level]
необязательно , nil разрешен

Максимальное количество параллельно выполняемых задач

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