Модуль google.cloud.gcp_cloudscheduler_job_info – Сбор информации о задании GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: google.cloud.gcp_cloudscheduler_job_info.
Описание
- Сбор информации о задании GCP
Требования
Ниже перечислены требования, которые должны быть выполнены на узле, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип аутентификации — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает, в какой среде Ansible вы выполняете этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. |
project строка | Проект Google Cloud Platform для использования. |
region строка / обязательно | Регион, в котором находится задача планировщика. |
scopes список / элементы=строка | Массив используемых областей |
| ... | ... |
Примечания
Примечание
- для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - значения переменных среды будут использоваться только в том случае, если значения книги задач не заданы.
- параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on a job
gcp_cloudscheduler_job_info:
region: us-central1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
appEngineHttpTarget complex |
Целевой объект App Engine HTTP. Если задание предоставляет целевой объект App Engine HTTP, cron отправит запрос в экземпляр службы. Возвращается: успешно |
|
appEngineRouting complex |
Настройка маршрутизации App Engine для задания. Возвращается: успешно |
|
instance string |
Экземпляр приложения. По умолчанию задание отправляется в доступный экземпляр при попытке выполнения задания. Возвращается: успешно |
|
service string |
Служба приложения. По умолчанию задание отправляется в службу, которая является службой по умолчанию при попытке выполнения задания. Возвращается: успешно |
|
version string |
Версия приложения. По умолчанию задание отправляется в версию, которая является версией по умолчанию при попытке выполнения задания. Возвращается: успешно |
|
body string |
Тело HTTP-запроса. Тело запроса разрешено только если метод HTTP — POST или PUT. Установка тела для задания с несовместимым HttpMethod приведет к ошибке недопустимого аргумента. Строка, закодированная в base64. Возвращается: успешно |
|
headers dictionary |
Заголовки HTTP-запроса. Эта карта содержит имена и значения полей заголовков. Заголовки можно установить при создании задания. Возвращается: успешно |
|
httpMethod string |
Какой метод HTTP использовать для запроса. Возвращается: успешно |
|
relativeUri string |
Относительный URI. Возвращается: успешно |
|
attemptDeadline string |
Крайний срок для попыток выполнения задания. Если обработчик запросов не отвечает в течение этого срока, запрос отменяется, а попытка помечается как сбой DEADLINE_EXCEEDED. Неудачная попытка может быть просмотрена в журналах выполнения. Cloud Scheduler повторит попытку выполнения задания в соответствии с RetryConfig. Допустимая длительность этого срока: * Для HTTP-целей — от 15 секунд до 30 минут. * Для целей App Engine HTTP — от 15 секунд до 24 часов. * **Примечание**: Для целей PubSub это поле игнорируется — его установка приведет к неразрешимой разнице. Длительность в секундах с точностью до девяти дробных знаков, заканчивающаяся на «s». Пример: «3.5s». Возвращается: успешно |
|
description string |
Описания задания, понятное человеку. Эта строка не должна содержать более 500 символов. Возвращается: успешно |
|
httpTarget complex |
HTTP-целевой объект. Если задание предоставляет http_target, cron отправит запрос на указанный URL-адрес. Возвращается: успешно |
|
body string |
Тело HTTP-запроса. Тело запроса разрешено только если метод HTTP — POST, PUT или PATCH. Установка тела для задания с несовместимым HttpMethod является ошибкой. Строка, закодированная в base64. Возвращается: успешно |
|
headers dictionary |
Эта карта содержит имена и значения полей заголовков. Повторяющиеся заголовки не поддерживаются, но значение заголовка может содержать запятые. Возвращается: успешно |
|
httpMethod string |
Какой метод HTTP использовать для запроса. Возвращается: успешно |
|
oauthToken complex |
Содержит информацию, необходимую для генерации маркера OAuth. Этот тип авторизации следует использовать при отправке запросов в конечную точку GCP. Возвращается: успешно |
|
scope string |
Область OAuth, которая будет использоваться для генерации токена доступа OAuth. Если не указано, будет использоваться «https://www.googleapis.com/auth/cloud-platform”. Возвращается: успешно |
|
serviceAccountEmail string |
Электронная почта учетной записи сервисного доступа, которая будет использоваться для генерации токена OAuth. Учетная запись сервисного доступа должна находиться в том же проекте, что и задача. Возвращено: success |
|
oidcToken complex |
Содержит информацию, необходимую для генерации токена OpenID Connect. Этот тип авторизации следует использовать при отправке запросов к сторонним конечным точкам или Cloud Run. Возвращено: success |
|
audience string |
Аудитория, которая будет использоваться при генерации токена OIDC. Если не указано, будет использоваться URI, указанный в целевом объекте. Возвращено: success |
|
serviceAccountEmail string |
Электронная почта учетной записи сервисного доступа, которая будет использоваться для генерации токена OAuth. Учетная запись сервисного доступа должна находиться в том же проекте, что и задача. Возвращено: success |
|
uri string |
Полный путь URI, на который будет отправлен запрос. Возвращено: success |
|
name string |
Имя задачи. Возвращено: success |
|
pubsubTarget complex |
Целевой объект Pub/Sub. Если задача предоставляет целевой объект Pub/Sub, планировщик будет публиковать сообщение в указанную тему. Возвращено: success |
|
attributes dictionary |
Атрибуты для PubsubMessage. Сообщение Pubsub должно содержать либо непустые данные, либо хотя бы один атрибут. Возвращено: success |
|
data string |
Полезная нагрузка сообщения для PubsubMessage. Сообщение Pubsub должно содержать либо непустые данные, либо хотя бы один атрибут. Строка, закодированная в base64. Возвращено: success |
|
topicName string |
Полное имя ресурса для темы Cloud Pub/Sub, в которую будут публиковаться сообщения при доставке задания. ~>**ПРИМЕЧАНИЕ:** Имя темы должно быть в том же формате, что и требуется для PubSub’s PublishRequest.name, например, `projects/my-project/topics/my-topic`. Возвращено: success |
|
region string |
Регион, в котором находится задача планировщика. Возвращено: success |
|
retryConfig complex |
По умолчанию, если задача не завершается успешно, то есть подтверждение не получено от обработчика, она будет перепробована с экспоненциальным отступом в соответствии с настройками. Возвращено: success |
|
maxBackoffDuration string |
Максимальное время ожидания перед повторной попыткой выполнения задачи после сбоя. Продолжительность в секундах с точностью до девяти десятичных знаков, заканчивающихся на «s». Возвращено: success |
|
maxDoublings integer |
Время между повторными попытками будет удваиваться maxDoublings раз. Интервал повтора задачи начинается с minBackoffDuration, затем удваивается maxDoublings раз, затем увеличивается линейно и, наконец, повторяется с интервалами maxBackoffDuration до retryCount раз. Возвращено: success |
|
maxRetryDuration string |
Предельный срок для повторной попытки выполнения неудачной задачи, измеряемый с момента первой попытки выполнения. Если указано с retryCount, задача будет повторяться до тех пор, пока не будут достигнуты оба предела. Продолжительность в секундах с точностью до девяти десятичных знаков, заканчивающихся на «s». Возвращено: success |
|
minBackoffDuration string |
Минимальное время ожидания перед повторной попыткой выполнения задачи после сбоя. Продолжительность в секундах с точностью до девяти десятичных знаков, заканчивающихся на «s». Возвращено: success |
|
retryCount integer |
Количество попыток, которые система предпримет для выполнения задания, используя процедуру экспоненциального отступа, описанную maxDoublings. Значения больше 5 и отрицательные значения недопустимы. Возвращено: success |
|
schedule string |
Описывает расписание, по которому будет выполняться задача. Возвращено: success |
|
timeZone string |
Указывает часовой пояс, который следует использовать для интерпретации расписания. Значение этого поля должно быть именем часового пояса из базы данных tz. Возвращаемое значение: success |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_cloudscheduler_job_info_module.html