Модуль google.cloud.gcp_cloudtasks_queue_info — сбор сведений об очереди GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_cloudtasks_queue_info.
Обзор
- Сбор сведений об очереди GCP
Требования
Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если в качестве типа учетных данных выбран accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это влияет только на строку User Agent для запросов API. |
location string / обязательный | Расположение очереди. |
project string | Проект Google Cloud Platform, который будет использоваться. |
scopes list / elements=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей это содержимое. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать 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 queue
gcp_cloudtasks_queue_info:
location: us-central1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
appEngineRoutingOverride complex |
Переопределения параметров appEngineRouting на уровне задачи. Эти параметры применяются только к задачам App Engine в этой очереди. Возвращается: при успехе |
|
host string |
Хост, на который отправляется задача. Возвращается: при успехе |
|
instance string |
Экземпляр приложения. По умолчанию задача отправляется на экземпляр, доступный в момент попытки ее выполнения. Возвращается: при успехе |
|
service string |
Сервис приложения. По умолчанию задача отправляется в сервис, который является сервисом по умолчанию в момент попытки ее выполнения. Возвращается: при успехе |
|
version string |
Версия приложения. По умолчанию задача отправляется на версию, которая является версией по умолчанию в момент попытки ее выполнения. Возвращается: при успехе |
|
location string |
Расположение очереди. Возвращается: при успехе |
|
name string |
Имя очереди. Возвращается: при успехе |
|
rateLimits complex |
Ограничения частоты отправки задач. Фактическая частота отправки задач из очереди определяется следующими факторами: * Количество задач в очереди * Заданные пользователем ограничения: rateLimits, retryConfig и состояние очереди. * Системные ограничения, вызванные ответами 429 (Too Many Requests) или 503 (Service Unavailable) от обработчика, высокой частотой ошибок или необходимостью сглаживать резкие скачки трафика. Возвращается: при успехе |
|
maxBurstSize integer |
Максимальный размер пакета. Максимальный размер пакета ограничивает скорость обработки задач в очереди, когда в ней много задач и частота высока. Это поле позволяет очереди работать с высокой частотой, чтобы обработка начиналась вскоре после добавления задачи, но при этом ограничивает использование ресурсов, если за короткий промежуток времени добавляется много задач. Возвращается: при успехе |
|
maxConcurrentDispatches integer |
Максимальное количество параллельных задач, которые Cloud Tasks может отправлять из этой очереди. После достижения этого порога Cloud Tasks прекращает отправлять задачи, пока количество параллельных запросов не уменьшится. Возвращается: при успехе |
|
maxDispatchesPerSecond string |
Максимальная частота отправки задач из этой очереди. Если значение не указано при создании очереди, Cloud Tasks выберет значение по умолчанию. Возвращается: при успехе |
|
retryConfig complex |
Параметры, определяющие поведение при повторных попытках. Возвращается: при успехе |
|
maxAttempts integer |
Количество попыток для каждой задачи. Cloud Tasks будет пытаться выполнить задачу maxAttempts раз (то есть, если первая попытка завершится неудачно, будет выполнено maxAttempts - 1 повторных попыток). Значение должно быть >= -1. Если значение не указано при создании очереди, Cloud Tasks выберет значение по умолчанию. -1 означает неограниченное количество попыток. Возвращается: при успехе |
|
maxBackoff string |
Если конфигурация RetryConfig очереди указывает, что задачу следует повторить, после сбоя она будет запланирована для повторной попытки через промежуток времени от minBackoff до maxBackoff. Возвращается: при успехе |
|
maxDoublings integer |
Интервал между повторными попытками будет удваиваться maxDoublings раз. Интервал повторных попыток задачи начинается с minBackoff, затем удваивается maxDoublings раз, после чего увеличивается линейно; в конце повторные попытки выполняются с интервалом maxBackoff, пока не будет достигнуто maxAttempts. Возвращается: при успехе |
|
maxRetryDuration string |
Если значение положительное, maxRetryDuration задает предельное время повторных попыток для неудачной задачи, отсчитываемое с момента первой попытки ее выполнения. По истечении maxRetryDuration, если задача была предпринята maxAttempts раз, дальнейшие попытки выполняться не будут, а задача будет удалена. Если значение равно нулю, срок существования задачи не ограничен. Возвращается: при успехе |
|
minBackoff string |
Если конфигурация RetryConfig очереди указывает, что задачу следует повторить, после сбоя она будет запланирована для повторной попытки через промежуток времени от minBackoff до maxBackoff. Возвращается: при успехе |
|
purgeTime string |
Время последней очистки этой очереди. Возвращается: при успехе |
|
stackdriverLoggingConfig complex |
Параметры настройки записи журналов в Stackdriver Logging. Возвращается: при успехе |
|
samplingRatio string |
Задает долю операций, записываемых в Stackdriver Logging. Это поле может принимать любое значение от 0.0 до 1.0 включительно. Значение по умолчанию — 0.0; оно означает, что операции не регистрируются. Возвращается: при успехе |
|
status string |
Текущее состояние очереди. Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_cloudtasks_queue_info_module.html