Модуль google.cloud.gcp_compute_region_backend_service – Создаёт GCP RegionBackendService

access_token

строка

Токен доступа OAuth2, если тип аутентификации — accesstoken.

affinity_cookie_ttl_sec

целое число

Срок жизни cookie в секундах, если session_affinity — GENERATED_COOKIE. Если установлено значение 0, cookie не сохраняется и действует только до конца сеанса браузера (или эквивалента). Максимальное разрешённое значение TTL — один день.

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

auth_kind

строка / обязательно

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

Варианты:

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

backends

список / элементы=словарь

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

balancing_mode

строка

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

Некоторые допустимые значения: «UTILIZATION», «RATE», «CONNECTION»

По умолчанию: "CONNECTION"

capacity_scaler

строка

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

~>**ПРИМЕЧАНИЕ**: Это поле нельзя установить для внутренних региональных бэкенд-сервисов (по умолчанию loadBalancingScheme), но оно требуется для бэкенд-сервисов, отличных от внутренних. Общее значение capacity_scaler для всех бэкендов должно быть отличным от нуля.

Значение 0 означает, что группа полностью отключена, предлагая 0% своей доступной ёмкости. Допустимый диапазон — [0.0, 1.0].

description

строка

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

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

failover

логическое значение

Это поле указывает, является ли бэкенд резервным. Для данного RegionBackendService можно настроить более одного резервного бэкенда.

Варианты:

• false
• true

group

строка / обязательно

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

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

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

При `load_balancing_scheme` типа INTERNAL поддерживаются только группы экземпляров.

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

max_connections

целое число

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

Не может быть установлено для внутренних бэкенд-сервисов.

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

max_connections_per_endpoint

целое число

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

Используется для расчета ёмкости группы. Может использоваться в режимах балансировки CONNECTION или UTILIZATION. Для режима CONNECTION необходимо установить либо maxConnections, либо maxConnectionsPerEndpoint.

max_connections_per_instance

целое число

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

Используется для расчета ёмкости группы.

Может использоваться в режимах балансировки CONNECTION или UTILIZATION.

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

max_rate

целое число

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

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

max_rate_per_endpoint

строка

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

max_rate_per_instance

строка

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

max_utilization

строка

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

Не может быть установлено для внутренних бэкенд-сервисов.

cdn_policy

dictionary

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

cache_key_policy

dictionary

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

include_host

boolean

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

Варианты:

• false
• true

include_protocol

boolean

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

Варианты:

• false
• true

include_query_string

boolean

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

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

Варианты:

• false
• true

query_string_blacklist

list / elements=string

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

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

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

query_string_whitelist

list / elements=string

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

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

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

cache_mode

string

Указывает настройку кэша для всех ответов от этого бэкенда.

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

Некоторые допустимые варианты включают: “USE_ORIGIN_HEADERS”, “FORCE_CACHE_ALL”, “CACHE_ALL_STATIC”

client_ttl

integer

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

default_ttl

integer

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

max_ttl

integer

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

negative_caching

boolean

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

Варианты:

• false
• true

negative_caching_policy

list / elements=dictionary

Устанавливает TTL кэша для указанного кода состояния HTTP. Для настройки negativeCachingPolicy необходимо включить negativeCaching.

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

code

integer

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

serve_while_stale

integer

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

signed_url_cache_max_age_sec

integer

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

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

По умолчанию: 3600

circuit_breakers

dictionary

Параметры, контролирующие объем подключений к службе бекенда. Это поле применимо только тогда, когда `load_balancing_scheme` установлен в INTERNAL_MANAGED, а `protocol` установлен в HTTP, HTTPS или HTTP2.

max_connections

integer

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

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

По умолчанию: 1024

max_pending_requests

integer

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

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

Default: 1024

max_requests

integer

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

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

Default: 1024

max_requests_per_connection

integer

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

max_retries

integer

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

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

Default: 3

connection_draining

dictionary

Настройки отключения соединений.

draining_timeout_sec

integer

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

Default: 300

consistent_hash

dictionary

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

Это поле применяется только тогда, когда все следующие условия истинны: * `load_balancing_scheme` установлен в INTERNAL_MANAGED * `protocol` установлен в HTTP, HTTPS или HTTP2 * `locality_lb_policy` установлен в MAGLEV или RING_HASH.

http_cookie

dictionary

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

Это поле применимо, если sessionAffinity установлен в HTTP_COOKIE.

name

string

Имя cookie.

path

string

Путь для установки cookie.

ttl

dictionary

Срок действия cookie.

nanos

integer

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

seconds

integer / required

Промежуток времени с разрешением в секунду.

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

http_header_name

string

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

Это поле применимо, если sessionAffinity установлен в HEADER_FIELD.

minimum_ring_size

integer

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

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

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

Default: 1024

description

string

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

enable_cdn

boolean

Если true, включить Cloud CDN для этого RegionBackendService.

Choices:

• false
• true

env_type

string

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

Это не должно устанавливаться, если вы не знаете, что делаете.

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

failover_policy

dictionary

Политика для отработки отказа.

disable_connection_drain_on_failover

boolean

При переключении или возврате в резервное состояние этот параметр указывает, будет ли соблюдаться процедура отключения соединений. Установка в значение true приведет к следующему: соединения со старым активным пулом не отключаются. Соединения с новым активным пулом используют таймаут в 10 минут (в настоящее время фиксировано). Установка в значение false приведет к следующему: для старых и новых соединений будет установлен таймаут отключения в 10 минут.

Это значение можно установить в true только если протокол TCP.

По умолчанию значение false.

Варианты:

• false
• true

drop_traffic_if_unhealthy

boolean

Этот параметр используется только в случае, если в группах первичных и резервных экземпляров не обнаружено здоровых виртуальных машин. При установке в значение true трафик отбрасывается. При установке в значение false новые соединения отправляются во все виртуальные машины в первичной группе.

По умолчанию значение false.

Варианты:

• false
• true

failover_ratio

string

Значение параметра должно быть в диапазоне [0, 1]. Если отношение здоровых виртуальных машин в первичном бэкенде равно или меньше этого значения, трафик, поступающий на балансировщик нагрузки по IP-адресу, будет перенаправлен на резервный бэкенд.

В случае, если ‘failoverRatio’ не задан или все виртуальные машины в резервном бэкенде неисправны, трафик будет перенаправлен обратно на первичный бэкенд в режиме «force», где трафик будет распределен по здоровым виртуальным машинам с наилучшими возможностями или по всем виртуальным машинам, если ни одна виртуальная машина не здорова.

Этот параметр используется только с балансировкой нагрузки L4.

health_checks

list / elements=string

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

Необходимо указать проверку работоспособности, если бэкенд-сервис не использует интернет или серверless NEG в качестве бэкенда.

load_balancing_scheme

string

Указывает тип балансировки нагрузки, для которого будет использоваться этот региональный бэкенд-сервис. Бэкенд-сервис, созданный для одного типа балансировки, не может использоваться с другим(и).

Некоторые допустимые значения: «EXTERNAL», «INTERNAL», «INTERNAL_MANAGED»

По умолчанию: "INTERNAL"

locality_lb_policy

string

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

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

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

* RING_HASH - Балансировщик нагрузки ring/modulo hash реализует консистентное хеширование бэкендов. Алгоритм обладает свойством, что добавление/удаление хоста из набора из N хостов влияет только на 1/N запросов.

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

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

* MAGLEV - используется как прямая замена балансировщику нагрузки ring hash.

Maglev не так стабилен, как ring hash, но имеет более быстрое время построения таблиц и время выбора хостов. Дополнительную информацию о Maglev см. в https://ai.google/research/pubs/pub44824 Этот параметр применим только в том случае, если `load_balancing_scheme` установлен в INTERNAL_MANAGED, а `protocol` установлен в HTTP, HTTPS или HTTP2.

Некоторые допустимые значения: «ROUND_ROBIN», «LEAST_REQUEST», «RING_HASH», «RANDOM», «ORIGINAL_DESTINATION», «MAGLEV»

log_config

dictionary

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

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

enable

boolean

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

Варианты:

• false
• true

sample_rate

string

Этот параметр можно указать только в том случае, если ведение журнала включено для этого бэкенд-сервиса. Значение параметра должно быть в диапазоне [0, 1]. Этот параметр настраивает коэффициент выборки запросов балансировщика нагрузки, где 1,0 означает, что все зарегистрированные запросы будут сообщены, а 0,0 означает, что ни один запрос не будет зарегистрирован.

Значение по умолчанию 1,0.

name

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

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

network

dictionary

URL сети, к которой принадлежит этот бэкенд-сервис.

Этот параметр может быть указан только при установке типа балансировки нагрузки в INTERNAL.

Этот параметр представляет ссылку на ресурс сети в GCP. Он может быть задан двумя способами. Во-первых, можно указать словарь с ключом ‘selfLink’ и значением selfLink вашего ресурса. Или можно добавить `register: name-of-resource` в задачу gcp_compute_network, а затем установить этот параметр сети в «{{ name-of-resource }}»

outlier_detection

dictionary

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

Этот параметр применим только в том случае, если `load_balancing_scheme` установлен в INTERNAL_MANAGED, а `protocol` установлен в HTTP, HTTPS или HTTP2.

base_ejection_time

dictionary

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

nanos

integer

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

секунды

целое число / обязательно

Промежуток времени с разрешением в секунду. Должно быть от 0 до 315 576 000 000 включительно.

consecutive_errors

целое число

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

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

По умолчанию: 5

consecutive_gateway_failure

целое число

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

По умолчанию: 5

enforcing_consecutive_errors

целое число

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

По умолчанию: 100

enforcing_consecutive_gateway_failure

целое число

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

enforcing_success_rate

целое число

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

По умолчанию: 100

interval

словарь

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

nanos

целое число

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

секунды

целое число / обязательно

Промежуток времени с разрешением в секунду. Должно быть от 0 до 315 576 000 000 включительно.

max_ejection_percent

целое число

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

По умолчанию: 10

success_rate_minimum_hosts

целое число

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

По умолчанию: 5

success_rate_request_volume

целое число

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

По умолчанию: 100

success_rate_stdev_factor

целое число

Этот множитель используется для определения порога исключения для исключения выбросов по показателю успешности. Порог исключения — это разность между средней успешностью и произведением этого множителя и стандартного отклонения средней успешности: среднее значение - (стандартное отклонение * success_rate_stdev_factor). Этот множитель делится на тысячу, чтобы получить число с плавающей запятой. То есть, если желаемый множитель равен 1,9, значение в процессе выполнения должно быть 1900. По умолчанию равно 1900.

По умолчанию: 1900

port_name

строка

Именованный порт на группе виртуальных машин бэкенда, представляющий порт для связи с виртуальными машинами бэкенда в этой группе. Требуется, когда loadBalancingScheme — EXTERNAL, INTERNAL_MANAGED или INTERNAL_SELF_MANAGED, а бэкэнды — группы виртуальных машин. Имя порта должно быть определено в каждой группе виртуальных машин бэкенда. Этот параметр не имеет значения, если бэкэнды — NEGs. API устанавливает значение по умолчанию «http», если оно не указано.

Должен быть опущен, когда loadBalancingScheme — INTERNAL (внутренняя балансировка TCP/UDP-трафика).

project

строка

Используемый проект Google Cloud Platform.

protocol

строка

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

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

Некоторые допустимые значения: «HTTP», «HTTPS», «HTTP2», «SSL», «TCP», «UDP», «GRPC»

region

строка / обязательно

Ссылка на регион, в котором находится региональная служба бэкенда.

scopes

список / элементы=строка

Массив областей, которые будут использованы

service_account_contents

jsonarg

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

service_account_email

строка

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

service_account_file

путь

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

session_affinity

строка

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

Некоторые допустимые значения: «NONE», «CLIENT_IP», «CLIENT_IP_PORT_PROTO», «CLIENT_IP_PROTO», «GENERATED_COOKIE», «HEADER_FIELD», «HTTP_COOKIE»

state

строка

Указывает, должен ли данный объект существовать в GCP

Выбор:

• "present" ← (по умолчанию)
• "absent"

timeout_sec

целое число

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

affinityCookieTtlSec

integer

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

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

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

backends

complex

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

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

balancingMode

string

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

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

capacityScaler

string

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

~>**ПРИМЕЧАНИЕ**: Это поле не может быть установлено для внутренних региональных служб обратного прокси (loadBalancingScheme по умолчанию), но требуется для служб обратного прокси, не являющихся INTERNAL. Суммарный capacity_scaler для всех бэкэндов должен быть не равен нулю.

Значение 0 означает, что группа полностью отключена, предлагая 0% своей доступной пропускной способности. Допустимый диапазон — [0.0,1.0].

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

description

string

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

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

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

failover

boolean

Это поле указывает, является ли это резервным бэкэндом. Для данного RegionBackendService можно настроить несколько резервных бэкэндов.

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

group

string

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

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

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

Когда `load_balancing_scheme` имеет значение INTERNAL, поддерживаются только группы экземпляров.

Обратите внимание, что вы должны указать ресурс группы экземпляров или группы конечных точек сети, используя полностью квалифицированный URL-адрес, а не частичный URL-адрес.

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

maxConnections

integer

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

Не может быть установлен для внутренних служб обратного прокси.

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

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

maxConnectionsPerEndpoint

integer

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

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

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

maxConnectionsPerInstance

integer

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

Это используется для расчета пропускной способности группы.

Может использоваться в режимах балансировки CONNECTION или UTILIZATION.

В режиме CONNECTION должно быть установлено либо maxConnections, либо maxConnectionsPerInstance.

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

maxRate

integer

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

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

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

maxRatePerEndpoint

string

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

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

maxRatePerInstance

string

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

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

maxUtilization

string

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

Не может быть установлен для внутренних служб обратного прокси.

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

cdnPolicy

complex

Конфигурация Cloud CDN для этой службы обратного прокси.

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

cacheKeyPolicy

complex

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

Возвращено: success

includeHost

boolean

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

Возвращено: success

includeProtocol

boolean

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

Возвращено: success

includeQueryString

boolean

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

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

Возвращено: success

queryStringBlacklist

list / elements=string

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

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

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

Возвращено: success

queryStringWhitelist

list / elements=string

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

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

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

Возвращено: success

cacheMode

string

Указывает настройку кэша для всех ответов от этого бэкэнда.

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

Возвращено: success

clientTtl

integer

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

Возвращено: success

defaultTtl

integer

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

Возвращено: success

maxTtl

integer

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

Возвращено: success

negativeCaching

boolean

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

Возвращено: success

negativeCachingPolicy

complex

Устанавливает TTL кэша для указанного кода состояния HTTP. Для настройки negativeCachingPolicy необходимо включить negativeCaching.

Пропуск политики и оставление negativeCaching включенным приведет к использованию TTL кэша по умолчанию Cloud CDN.

Возвращено: success

code

integer

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

Возвращено: success

serveWhileStale

integer

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

Возвращено: success

signedUrlCacheMaxAgeSec

integer

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

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

Возвращено: success

circuitBreakers

complex

Настройки, контролирующие объем подключений к службе бекенда. Это поле применимо только тогда, когда `load_balancing_scheme` установлен в INTERNAL_MANAGED, а `protocol` установлен в HTTP, HTTPS или HTTP2.

Возвращено: success

maxConnections

integer

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

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

Возвращено: success

maxPendingRequests

integer

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

Значение по умолчанию: 1024.

Returned: success

maxRequests

integer

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

Значение по умолчанию: 1024.

Returned: success

maxRequestsPerConnection

integer

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

Returned: success

maxRetries

integer

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

Значение по умолчанию: 3.

Returned: success

connectionDraining

complex

Настройки для отключения соединений.

Returned: success

drainingTimeoutSec

integer

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

Returned: success

consistentHash

complex

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

Это поле применяется только тогда, когда истинны все следующие условия: * `load_balancing_scheme` установлен в INTERNAL_MANAGED * `protocol` установлен в HTTP, HTTPS или HTTP2 * `locality_lb_policy` установлен в MAGLEV или RING_HASH.

Returned: success

httpCookie

complex

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

Это поле применимо, если sessionAffinity установлено в HTTP_COOKIE.

Returned: success

name

string

Имя cookie.

Returned: success

path

string

Путь для установки cookie.

Returned: success

ttl

complex

Время жизни cookie.

Returned: success

nanos

integer

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

Returned: success

seconds

integer

Промежуток времени с разрешением в секунду.

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

Returned: success

httpHeaderName

string

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

Это поле применимо, если sessionAffinity установлено в HEADER_FIELD.

Returned: success

minimumRingSize

integer

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

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

Значение по умолчанию: 1024.

Returned: success

creationTimestamp

string

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

Returned: success

description

string

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

Returned: success

enableCDN

boolean

Если true, включите Cloud CDN для этого RegionBackendService.

Returned: success

failoverPolicy

complex

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

Возвращаемое значение: success

disableConnectionDrainOnFailover

boolean

При аварийном переключении или возврате к исходному состоянию этот параметр указывает, будет ли соблюдаться сброс соединений. Установка в значение true имеет следующий эффект: соединения со старым активным пулом не сбрасываются. Соединения с новым активным пулом используют таймаут в 10 минут (в настоящее время фиксированный). Установка в значение false имеет следующий эффект: как старые, так и новые соединения будут иметь таймаут сброса в 10 минут.

Это значение можно установить в true только в том случае, если протокол TCP.

По умолчанию значение false.

Возвращаемое значение: success

dropTrafficIfUnhealthy

boolean

Этот параметр используется только в том случае, если в группах виртуальных машин первичного и резервного копирования не обнаружено здоровых виртуальных машин. При установке в значение true трафик отбрасывается. При установке в значение false новые соединения направляются на все виртуальные машины в первичной группе.

По умолчанию значение false.

Возвращаемое значение: success

failoverRatio

string

Значение поля должно быть в диапазоне [0, 1]. Если коэффициент здоровых виртуальных машин в первичном бэкенде равен или меньше этого числа, входящий в балансировщик нагрузки IP-трафик будет направлен на бэкенд резервного копирования.

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

Это поле используется только с балансировкой нагрузки уровня 4.

Возвращаемое значение: success

fingerprint

string

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

Возвращаемое значение: success

healthChecks

list / elements=string

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

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

Возвращаемое значение: success

id

integer

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

Возвращаемое значение: success

loadBalancingScheme

string

Указывает, для какой балансировки нагрузки будет использоваться этот региональный бэкенд-сервис. Бэкенд-сервис, созданный для одного типа балансировки, не может использоваться с другим(ими).

Возвращаемое значение: success

localityLbPolicy

string

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

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

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

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

* RANDOM - Балансировщик нагрузки выбирает случайную здоровую машину.

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

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

Maglev не такой стабильный, как ring hash, но имеет более быстрые времена построения таблиц и выбор узлов. Для получения дополнительной информации о Maglev см. https://ai.google/research/pubs/pub44824 Это поле применимо только тогда, когда `load_balancing_scheme` установлено в `INTERNAL_MANAGED`, а `protocol` установлено в `HTTP`, `HTTPS` или `HTTP2`.

Возвращаемое значение: success

logConfig

complex

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

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

Возвращаемое значение: success

enable

boolean

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

Возвращаемое значение: success

sampleRate

string

Это поле можно указать только в том случае, если ведение журнала включено для этого бэкенд-сервиса. Значение поля должно быть в диапазоне [0, 1]. Этот параметр настраивает коэффициент выборки запросов к балансировщику, где 1,0 означает, что все запросы, подлежащие протоколированию, будут сообщаться, а 0,0 — что запросы, подлежащие протоколированию, не будут сообщаться.

Значение по умолчанию 1,0.

Возвращаемое значение: success

name

string

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

Возвращаемое значение: success

network

dictionary

URL сети, к которой принадлежит этот бэкенд-сервис.

Это поле можно указать только при установке схемы балансировки нагрузки в значение INTERNAL.

Возвращаемое значение: success

outlierDetection

complex

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

Это поле применимо только тогда, когда `load_balancing_scheme` установлен в INTERNAL_MANAGED, а `protocol` установлен в HTTP, HTTPS или HTTP2.

Возвращено: success

baseEjectionTime

complex

Базовое время, на которое узел выключается. Реальное время равно базовому времени, умноженному на количество раз, когда узел был выключен. По умолчанию 30000 мс или 30 с.

Возвращено: success

nanos

integer

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

Возвращено: success

seconds

integer

Промежуток времени с разрешением в одну секунду. Должно быть от 0 до 315 576 000 000 включительно.

Возвращено: success

consecutiveErrors

integer

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

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

Возвращено: success

consecutiveGatewayFailure

integer

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

Возвращено: success

enforcingConsecutiveErrors

integer

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

Возвращено: success

enforcingConsecutiveGatewayFailure

integer

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

Возвращено: success

enforcingSuccessRate

integer

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

Возвращено: success

interval

complex

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

Возвращено: success

nanos

integer

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

Возвращено: success

seconds

integer

Промежуток времени с разрешением в одну секунду. Должно быть от 0 до 315 576 000 000 включительно.

Возвращено: success

maxEjectionPercent

integer

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

Возвращено: success

successRateMinimumHosts

integer

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

Возвращено: success

successRateRequestVolume

integer

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

Возвращено: success

successRateStdevFactor

integer

Этот коэффициент используется для определения порогового значения удаления для удаления выбросов по показателю успешности. Пороговое значение удаления — это разница между средним показателем успешности и произведением этого коэффициента и стандартного отклонения среднего показателя успешности: среднее - (стандартное отклонение * success_rate_stdev_factor). Этот коэффициент делится на тысячу, чтобы получить число с плавающей точкой. То есть, если нужный коэффициент равен 1,9, значение времени выполнения должно быть 1900. По умолчанию 1900.

Возвращено: success

portName

string

Имя порта на группе бэкенд-инстансов, представляющее порт для связи с бэкенд-виртуальными машинами в этой группе. Требуется, когда loadBalancingScheme — EXTERNAL, INTERNAL_MANAGED или INTERNAL_SELF_MANAGED, а бэкенды — группы инстансов. Имя порта должно быть определено в каждой группе бэкенд-инстансов. Этот параметр не имеет смысла, если бэкенды — NEGs. API устанавливает значение по умолчанию «http», если оно не указано.

Должно быть опущено, если loadBalancingScheme — INTERNAL (внутренний балансировщик TCP/UDP).

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

protocol

string

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

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

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

region

string

Ссылка на регион, в котором находится региональный бэкенд-сервис.

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

sessionAffinity

string

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

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

timeoutSec

integer

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

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