модуль google.cloud.gcp_compute_backend_service_info — сбор сведений о GCP BackendService

access_token

string

Токен доступа OAuth2, если тип учётных данных — accesstoken.

auth_kind

string / обязательный

Тип используемых учётных данных.

Варианты:

• "application"
• "machineaccount"
• "serviceaccount"
• "accesstoken"

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте это значение, если не знаете, что делаете.

Это значение изменяет только строку User Agent для запросов к API.

filters

list / элементы=string

Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 and filter2).

project

string

Проект Google Cloud Platform, который нужно использовать.

scopes

list / элементы=string

Массив используемых областей действия

service_account_contents

jsonarg

Содержимое JSON-файла учётной записи службы в виде словаря или JSON-строки, представляющей его.

service_account_email

string

Необязательный адрес электронной почты учётной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.

service_account_file

path

Путь к JSON-файлу учётной записи службы, если в качестве типа выбрано serviceaccount.

resources

complex

Список ресурсов

Возвращается: всегда

affinityCookieTtlSec

integer

Время жизни файлов cookie в секундах, если для session_affinity задано значение GENERATED_COOKIE. Если значение равно 0, файл cookie не является постоянным и действует только до завершения сеанса браузера (или его аналога). Максимально допустимое значение TTL — один день.

Если схема балансировки нагрузки — INTERNAL, это поле не используется.

Возвращается: при успешном выполнении

backends

complex

Набор бэкендов, обслуживающих этот BackendService.

Возвращается: при успешном выполнении

balancingMode

string

Указывает режим балансировки для этого бэкенда.

Для глобальной балансировки нагрузки HTTP(S) или TCP/SSL по умолчанию используется UTILIZATION. Допустимые значения: UTILIZATION, RATE (для HTTP(S)) и CONNECTION (для TCP/SSL).

Возвращается: при успешном выполнении

capacityScaler

string

Множитель, применяемый к максимальной пропускной способности группы (на основе UTILIZATION, RATE или CONNECTION).

Значение по умолчанию — 1, то есть группа будет обслуживать нагрузку в объёме до 100% настроенной пропускной способности (в зависимости от balancingMode). Значение 0 означает, что группа полностью выведена из обслуживания и предоставляет 0% доступной пропускной способности. Допустимый диапазон: [0.0,1.0].

Возвращается: при успешном выполнении

description

string

Необязательное описание этого ресурса.

Укажите это свойство при создании ресурса.

Возвращается: при успешном выполнении

group

string

Полный URL ресурса Instance Group или Network Endpoint Group. Для группы экземпляров это свойство определяет список экземпляров, обслуживающих трафик. Виртуальные машины — участники каждой группы экземпляров должны находиться в той же зоне, что и сама группа экземпляров. Два бэкенда одной службы бэкенда не могут использовать один и тот же ресурс Instance Group.

Для Network Endpoint Groups это свойство определяет список конечных точек. Все конечные точки Network Endpoint Group должны размещаться на экземплярах, расположенных в той же зоне, что и Network Endpoint Group.

Службы бэкенда не могут одновременно использовать бэкенды Instance Group и Network Endpoint Group.

Обратите внимание: ресурс Instance Group или Network Endpoint Group необходимо указывать с помощью полного URL, а не частичного URL.

Возвращается: при успешном выполнении

maxConnections

integer

Максимальное количество одновременных подключений для группы. Можно использовать с режимами балансировки CONNECTION или UTILIZATION.

Для режима CONNECTION необходимо задать maxConnections или один из параметров maxConnectionsPerInstance либо maxConnectionsPerEndpoint — в зависимости от типа группы.

Возвращается: при успешном выполнении

maxConnectionsPerEndpoint

integer

Максимальное количество одновременных подключений, которое может обрабатывать одна сетевая конечная точка бэкенда. Это значение используется для расчёта пропускной способности группы. Можно использовать в режимах балансировки CONNECTION или UTILIZATION.

Для режима CONNECTION необходимо задать maxConnections или maxConnectionsPerEndpoint.

Возвращается: при успешном выполнении

maxConnectionsPerInstance

integer

Максимальное количество одновременных подключений, которое может обрабатывать один экземпляр бэкенда. Это значение используется для расчёта пропускной способности группы. Можно использовать в режимах балансировки CONNECTION или UTILIZATION.

Для режима CONNECTION необходимо задать maxConnections или maxConnectionsPerInstance.

Возвращается: при успешном выполнении

maxRate

integer

Максимальное количество запросов в секунду (RPS) для группы.

Можно использовать с режимами балансировки RATE или UTILIZATION, но для режима RATE параметр обязателен. Для режима RATE необходимо задать maxRate или один из параметров maxRatePerInstance либо maxRatePerEndpoint — в зависимости от типа группы.

Возвращается: при успешном выполнении

maxRatePerEndpoint

string

Максимальное количество запросов в секунду (RPS), которое может обрабатывать одна сетевая конечная точка бэкенда. Это значение используется для расчёта пропускной способности группы. Можно использовать в любом режиме балансировки. Для режима RATE необходимо задать maxRate или maxRatePerEndpoint.

Возвращается: при успешном выполнении

maxRatePerInstance

string

Максимальное количество запросов в секунду (RPS), которое может обрабатывать один экземпляр бэкенда. Это значение используется для расчёта пропускной способности группы. Можно использовать в любом режиме балансировки. Для режима RATE необходимо задать maxRate или maxRatePerInstance.

Возвращается: при успешном выполнении

maxUtilization

string

Используется, когда для balancingMode задано значение UTILIZATION. Это отношение определяет целевую загрузку ЦП для группы. Допустимый диапазон: [0.0, 1.0].

Возвращается: при успешном выполнении

cdnPolicy

complex

Конфигурация Cloud CDN для этого BackendService.

Возвращается: при успешном выполнении

cacheKeyPolicy

complex

Политика CacheKeyPolicy для этой CdnPolicy.

Возвращается: при успешном выполнении

includeHost

boolean

Если значение равно true, запросы к разным хостам будут кэшироваться отдельно.

Возвращается: при успешном выполнении

includeProtocol

boolean

Если значение равно true, запросы HTTP и HTTPS будут кэшироваться отдельно.

Возвращается: при успешном выполнении

includeQueryString

boolean

Если значение равно true, параметры строки запроса включаются в ключ кэша согласно query_string_whitelist и query_string_blacklist. Если ни один из этих параметров не задан, включается вся строка запроса.

Если значение равно false, строка запроса полностью исключается из ключа кэша.

Возвращается: при успешном выполнении

queryStringBlacklist

list / elements=string

Имена параметров строки запроса, которые следует исключить из ключей кэша.

Все остальные параметры будут включены. Укажите либо query_string_whitelist, либо query_string_blacklist, но не оба параметра одновременно.

Символы ‘&’ и ‘=’ будут закодированы в процентах и не будут считаться разделителями.

Возвращается: при успешном выполнении

queryStringWhitelist

list / elements=string

Имена параметров строки запроса, которые следует включить в ключи кэша.

Все остальные параметры будут исключены. Укажите либо query_string_whitelist, либо query_string_blacklist, но не оба параметра одновременно.

Символы ‘&’ и ‘=’ будут закодированы в процентах и не будут считаться разделителями.

Возвращается: при успешном выполнении

cacheMode

string

Задаёт параметры кэширования всех ответов от этого бэкенда.

Возможные значения: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL и CACHE_ALL_STATIC .

Возвращается: при успешном выполнении

clientTtl

integer

Задаёт максимально допустимое значение TTL для кэшированного содержимого, предоставляемого этим источником.

Возвращается: при успешном выполнении

defaultTtl

integer

Задаёт TTL по умолчанию для кэшированного содержимого, предоставляемого этим источником, если в ответе нет действующего значения TTL (max-age или s-max-age).

Возвращается: при успешном выполнении

maxTtl

integer

Задаёт максимально допустимое значение TTL для кэшированного содержимого, предоставляемого этим источником.

Возвращается: при успешном выполнении

negativeCaching

boolean

Отрицательное кэширование позволяет задавать TTL для отдельных кодов состояния, обеспечивая более точную настройку кэширования распространённых ошибок или перенаправлений.

Возвращается: при успешном выполнении

negativeCachingPolicy

complex

Задаёт TTL кэша для указанного кода состояния HTTP. Чтобы настроить negativeCachingPolicy, необходимо включить negativeCaching.

Если не указывать политику, оставив negativeCaching включённым, будут использоваться TTL кэша Cloud CDN по умолчанию.

Возвращается: при успешном выполнении

code

integer

Код состояния HTTP, для которого задаётся TTL. В качестве значений можно указывать только коды состояния HTTP 300, 301, 308, 404, 405, 410, 421, 451 и 501; один и тот же код состояния нельзя указывать более одного раза.

Возвращается: при успешном выполнении

ttl

integer

TTL (в секундах), в течение которого кэшируются ответы с соответствующим кодом состояния. Максимально допустимое значение — 1800 с (30 минут); обратите внимание, что редко используемые объекты могут быть удалены из кэша до истечения заданного TTL.

Возвращается: при успешном выполнении

serveWhileStale

integer

Предоставлять имеющееся содержимое из кэша (если оно доступно) во время повторной проверки содержимого у источника или при возникновении ошибки при обновлении кэша.

Возвращается: при успешном выполнении

signedUrlCacheMaxAgeSec

integer

Максимальное количество секунд, в течение которых ответ на запрос с подписанным URL считается актуальным. По умолчанию — 1 час (3600 с). По истечении этого времени ответ будет повторно проверен перед предоставлением.

При предоставлении ответов на запросы с подписанными URL Cloud CDN будет внутренне обрабатывать все ответы от этого бэкенда так, как если бы они содержали заголовок «Cache-Control: public, max-age=[TTL]», независимо от наличия других заголовков Cache-Control. Фактически отправляемые в ответах заголовки не изменяются.

Возвращается: при успешном выполнении

circuitBreakers

complex

Параметры, регулирующие объём подключений к службе бэкенда. Это поле применимо только при значении INTERNAL_SELF_MANAGED параметра load_balancing_scheme.

Возвращается: при успешном выполнении

maxConnections

integer

Максимальное количество подключений к кластеру бэкенда.

По умолчанию — 1024.

Возвращается: при успешном выполнении

maxPendingRequests

integer

Максимальное количество ожидающих запросов к кластеру бэкенда.

По умолчанию — 1024.

Возвращается: при успешном выполнении

maxRequests

integer

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

По умолчанию — 1024.

Возвращается: при успешном выполнении

maxRequestsPerConnection

integer

Максимальное количество запросов для одного подключения к бэкенду. Этот параметр учитывается как реализациями HTTP/1.1, так и HTTP/2. Если параметр не задан, ограничение отсутствует. Значение 1 фактически отключает постоянное подключение.

Возвращается: при успешном выполнении

maxRetries

integer

Максимальное количество параллельных повторных попыток к кластеру бэкенда.

По умолчанию — 3.

Возвращается: при успешном выполнении

connectionDraining

complex

Параметры отключения подключений.

Возвращается: при успешном выполнении

drainingTimeoutSec

integer

Время, в течение которого экземпляр выводится из обслуживания: он не принимает новые подключения, но продолжает работу, чтобы завершить уже начатые.

Возвращается: при успешном выполнении

consistentHash

complex

Балансировка нагрузки на основе согласованного хеширования может обеспечивать условную привязку сеанса на основе заголовков HTTP, файлов cookie или других свойств. Эта политика балансировки нагрузки применима только к HTTP-подключениям. Привязка к определённому целевому хосту теряется при добавлении или удалении одного либо нескольких хостов из целевой службы. Это поле задаёт параметры управления согласованным хешированием. Поле применяется только при значении INTERNAL_SELF_MANAGED параметра load_balancing_scheme. Поле применимо только при значении MAGLEV или RING_HASH параметра locality_lb_policy.

Возвращается: при успешном выполнении

httpCookie

complex

Хеширование выполняется на основе файла cookie HTTP. Это поле описывает файл cookie HTTP, который будет использоваться в качестве ключа хеширования для балансировщика нагрузки с согласованным хешированием. Если файл cookie отсутствует, он будет создан.

Поле применимо, если для sessionAffinity задано значение HTTP_COOKIE.

Возвращается: при успешном выполнении

name

string

Имя файла cookie.

Возвращается: при успешном выполнении

path

string

Путь, который нужно задать для файла cookie.

Возвращается: при успешном выполнении

ttl

complex

Время жизни файла cookie.

Возвращается: при успешном выполнении

nanos

integer

Доля секунды, выраженная с точностью до наносекунд. Длительности менее одной секунды представляются значением поля seconds, равным 0, и положительным значением поля nanos. Допустимый диапазон — от 0 до 999 999 999 включительно.

Возвращается: при успешном выполнении

seconds

integer

Интервал времени с точностью до секунды.

Значение должно быть от 0 до 315,576,000,000 включительно.

Возвращается: успешно

httpHeaderName

string

Хеш, основанный на значении указанного поля заголовка.

Это поле применимо, если для sessionAffinity задано значение HEADER_FIELD.

Возвращается: успешно

minimumRingSize

integer

Минимальное количество виртуальных узлов, используемых для хеш-кольца.

Чем больше размер кольца, тем более детализировано распределение нагрузки. Если количество хостов в пуле балансировки нагрузки превышает размер кольца, каждому хосту будет назначен один виртуальный узел.

По умолчанию — 1024.

Возвращается: успешно

creationTimestamp

string

Временная метка создания в текстовом формате RFC3339.

Возвращается: успешно

customRequestHeaders

list / elements=string

Заголовки, которые балансировщик нагрузки HTTP/S должен добавлять к проксируемым запросам.

Возвращается: успешно

customResponseHeaders

list / elements=string

Заголовки, которые балансировщик нагрузки HTTP/S должен добавлять к проксируемым ответам.

Возвращается: успешно

description

string

Необязательное описание этого ресурса.

Возвращается: успешно

enableCDN

boolean

Если значение равно true, включить Cloud CDN для этого BackendService.

Возвращается: успешно

fingerprint

string

Отпечаток этого ресурса. Хеш содержимого, хранящегося в этом объекте. Это поле используется для оптимистической блокировки.

Возвращается: успешно

healthChecks

list / elements=string

Набор URL-адресов ресурсов HttpHealthCheck или HttpsHealthCheck для проверки работоспособности этого BackendService. В настоящее время можно указать не более одной проверки работоспособности.

Проверку работоспособности необходимо указать, если только в качестве бэкенда службы бэкенда не используется интернет- или бессерверный NEG.

Для внутренней балансировки нагрузки вместо этого необходимо указать URL-адрес ресурса HealthCheck.

Возвращается: успешно

iap

complex

Настройки для включения Cloud Identity-Aware Proxy.

Возвращается: успешно

enabled

boolean

Включает IAP.

Возвращается: успешно

oauth2ClientId

string

Идентификатор клиента OAuth2 для IAP.

Возвращается: успешно

oauth2ClientSecret

string

Секрет клиента OAuth2 для IAP.

Возвращается: успешно

oauth2ClientSecretSha256

string

Хеш SHA-256 секрета клиента OAuth2 для IAP.

Возвращается: успешно

id

integer

Уникальный идентификатор ресурса.

Возвращается: успешно

loadBalancingScheme

string

Указывает, будет ли служба бэкенда использоваться для внутренней или внешней балансировки нагрузки. Службу бэкенда, созданную для одного типа балансировки нагрузки, нельзя использовать с другим типом.

Возвращается: успешно

localityLbPolicy

string

Алгоритм балансировки нагрузки, используемый в пределах области локальности.

Возможные значения: * ROUND_ROBIN — простая политика, при которой каждый работоспособный бэкенд выбирается по очереди.

* LEAST_REQUEST — алгоритм, который выбирает два случайных работоспособных хоста и использует тот, у которого меньше активных запросов.

* RING_HASH — балансировщик нагрузки с хешированием по кольцу/модулю реализует согласованное хеширование для бэкендов. Алгоритм обладает свойством: добавление или удаление хоста из набора из N хостов влияет только на 1/N запросов.

* RANDOM — балансировщик нагрузки выбирает случайный работоспособный хост.

* ORIGINAL_DESTINATION — бэкенд-хост выбирается на основе метаданных клиентского соединения: соединения устанавливаются с тем же адресом, что и адрес назначения входящего соединения до его перенаправления на балансировщик нагрузки.

* MAGLEV — используется как прямая замена балансировщика нагрузки с хешированием по кольцу.

Maglev уступает хешированию по кольцу в стабильности, но обеспечивает более быстрое построение таблицы и выбор хоста. Дополнительные сведения о Maglev см. по адресу https://ai.google/research/pubs/pub44824. Это поле применимо только в том случае, если для load_balancing_scheme задано значение INTERNAL_SELF_MANAGED.

Возвращается: успешно

logConfig

complex

Это поле задаёт параметры ведения журналов трафика балансировщика нагрузки, обслуживаемого этой службой бэкенда.

Если ведение журналов включено, журналы будут экспортироваться в Stackdriver.

Возвращается: успешно

enable

boolean

Включает ли ведение журналов трафика балансировщика нагрузки, обслуживаемого этой службой бэкенда.

Возвращается: успешно

sampleRate

string

Это поле можно указать, только если для этой службы бэкенда включено ведение журналов. Значение поля должно находиться в диапазоне [0, 1]. Здесь задаётся частота выборки запросов к балансировщику нагрузки: значение 1.0 означает, что регистрируются все запросы, а 0.0 — что не регистрируется ни один запрос.

Значение по умолчанию — 1.0.

Возвращается: успешно

name

string

Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы, кроме последнего, должны быть дефисом, строчной буквой или цифрой; последний символ не может быть дефисом.

Возвращается: успешно

outlierDetection

complex

Настройки, управляющие удалением неработоспособных хостов из пула балансировки нагрузки.

Это поле применимо только в том случае, если для load_balancing_scheme задано значение INTERNAL_SELF_MANAGED.

Возвращается: успешно

baseEjectionTime

complex

Базовое время, на которое хост исключается из пула. Фактическое время равно базовому времени, умноженному на количество исключений хоста. По умолчанию — 30000 мс, или 30 с.

Возвращается: успешно

nanos

integer

Интервал времени, составляющий долю секунды, с точностью до наносекунд. Интервалы длительностью менее секунды представляются значением 0 в поле `seconds` и положительным значением в поле `nanos`. Значение должно быть от 0 до 999,999,999 включительно.

Возвращается: успешно

seconds

integer

Интервал времени с точностью до секунды. Значение должно быть от 0 до 315,576,000,000 включительно.

Возвращается: успешно

consecutiveErrors

integer

Количество ошибок, после которого хост исключается из пула соединений. При обращении к бэкенд-хосту по HTTP код ответа 5xx считается ошибкой.

По умолчанию — 5.

Возвращается: успешно

consecutiveGatewayFailure

integer

Количество последовательных сбоев шлюза (статусы 502, 503, 504 или ошибки соединения, преобразованные в один из этих кодов статуса), после которого происходит исключение хоста из-за последовательных сбоев шлюза. По умолчанию — 5.

Возвращается: успешно

enforcingConsecutiveErrors

integer

Вероятность в процентах того, что хост действительно будет исключён при обнаружении аномального статуса по последовательным ошибкам 5xx. Этот параметр можно использовать, чтобы отключить исключение или постепенно увеличивать его интенсивность. По умолчанию — 100.

Возвращается: успешно

enforcingConsecutiveGatewayFailure

integer

Вероятность в процентах того, что хост действительно будет исключён при обнаружении аномального статуса по последовательным сбоям шлюза. Этот параметр можно использовать, чтобы отключить исключение или постепенно увеличивать его интенсивность. По умолчанию — 0.

Возвращается: успешно

enforcingSuccessRate

integer

Вероятность в процентах того, что хост действительно будет исключён при обнаружении аномального статуса по статистике успешных запросов. Этот параметр можно использовать, чтобы отключить исключение или постепенно увеличивать его интенсивность. По умолчанию — 100.

Возвращается: успешно

interval

complex

Интервал между проверками для анализа исключения хостов. Это может привести как к исключению новых хостов, так и к возвращению хостов в работу. По умолчанию — 10 секунд.

Возвращается: успешно

nanos

integer

Интервал времени, составляющий долю секунды, с точностью до наносекунд. Интервалы длительностью менее секунды представляются значением 0 в поле `seconds` и положительным значением в поле `nanos`. Значение должно быть от 0 до 999,999,999 включительно.

Возвращается: успешно

seconds

integer

Интервал времени с точностью до секунды. Значение должно быть от 0 до 315,576,000,000 включительно.

Возвращается: успешно

maxEjectionPercent

integer

Максимальная доля хостов в пуле балансировки нагрузки службы бэкенда, которые могут быть исключены. По умолчанию — 10%.

Возвращается: успешно

successRateMinimumHosts

integer

Количество хостов в кластере, на которых должен быть достаточный объём запросов для обнаружения аномалий по доле успешных запросов. Если количество хостов меньше этого значения, обнаружение аномалий по статистике успешных запросов не выполняется ни для одного хоста кластера. По умолчанию — 5.

Возвращается: успешно

successRateRequestVolume

integer

Минимальное общее количество запросов, которое необходимо собрать за один интервал (определяемый указанной выше длительностью интервала), чтобы включить этот хост в обнаружение аномалий на основе доли успешных запросов. Если объём запросов меньше этого значения, обнаружение аномалий по статистике успешных запросов для этого хоста не выполняется. По умолчанию — 100.

Возвращается: успешно

successRateStdevFactor

integer

Этот коэффициент используется для определения порога исключения при обнаружении аномалий по доле успешных запросов. Порог исключения — это разница между средней долей успешных запросов и произведением этого коэффициента на стандартное отклонение средней доли успешных запросов: mean - (stdev * success_rate_stdev_factor). Для получения значения типа double этот коэффициент делится на тысячу. Например, если требуемый коэффициент равен 1.9, во время выполнения следует использовать значение 1900. По умолчанию — 1900.

Возвращается: успешно

portName

string

Имя порта бэкенда. Такое же имя должно быть у групп экземпляров, на которые ссылается эта служба. Обязательно, если схема балансировки нагрузки — EXTERNAL.

Возвращается: успешно

protocol

string

Протокол, используемый этим BackendService для связи с бэкендами.

По умолчанию используется HTTP. **ПРИМЕЧАНИЕ**: HTTP2 допустим только для типов балансировщиков нагрузки HTTP/2 в бета-версии и может приводить к ошибкам при использовании с API GA.

Возвращается: успешно

securityPolicy

string

Политика безопасности, связанная с этой службой бэкенда.

Возвращается: успешно

sessionAffinity

string

Тип используемой привязки сеанса. По умолчанию — NONE. Привязка сеанса не применяется, если используется протокол UDP.

Возвращается: успешно

timeoutSec

integer

Количество секунд ожидания ответа от бэкенда, прежде чем запрос будет считаться неудачным. По умолчанию — 30 секунд. Допустимый диапазон — [1, 86400].

Возвращается: успешно