модуль google.cloud.gcp_compute_region_backend_service – создание GCP RegionBackendService

access_token

string

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

affinity_cookie_ttl_sec

integer

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

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

auth_kind

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

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

Варианты:

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

backends

list / elements=dictionary

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

balancing_mode

string

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

Допустимые варианты: «UTILIZATION», «RATE», «CONNECTION»

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

capacity_scaler

string

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

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

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

description

string

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

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

failover

boolean

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

Варианты:

• false
• true

group

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

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

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

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

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

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

max_connections

integer

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

Нельзя задать для бэкенд-сервисов INTERNAL.

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

max_connections_per_endpoint

integer

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

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

max_connections_per_instance

integer

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

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

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

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

max_rate

integer

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

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

max_rate_per_endpoint

string

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

max_rate_per_instance

string

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

max_utilization

string

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

Нельзя задать для бэкенд-сервисов INTERNAL.

cdn_policy

dictionary

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

cache_key_policy

dictionary

Политика CacheKeyPolicy для этой 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.

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

max_requests

integer

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

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

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

max_requests_per_connection

integer

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

max_retries

integer

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

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

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

connection_draining

dictionary

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

draining_timeout_sec

integer

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

По умолчанию: 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

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

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

name

string

Имя файла cookie.

path

string

Путь, задаваемый для файла cookie.

ttl

dictionary

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

nanos

integer

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

seconds

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

Длительность, заданная с точностью до секунды.

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

http_header_name

string

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

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

minimum_ring_size

integer

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

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

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

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

description

string

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

enable_cdn

boolean

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

Варианты:

• 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` не задан или все виртуальные машины в резервной серверной части неработоспособны, трафик будет перенаправлен в основную серверную часть в принудительном режиме. В этом режиме трафик по возможности распределяется между работоспособными виртуальными машинами, а если таких нет — между всеми виртуальными машинами.

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

health_checks

list / elements=string

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

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

load_balancing_scheme

string

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

Допустимые варианты: “EXTERNAL”, “INTERNAL”, “INTERNAL_MANAGED”

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

locality_lb_policy

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_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.

Это поле представляет ссылку на ресурс Network в GCP. Его можно указать двумя способами. Во-первых, можно поместить словарь с ключом ‘selfLink’ и значением selfLink ресурса. Кроме того, можно добавить `register: name-of-resource` в задачу gcp_compute_network, а затем задать для этого поля 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 включительно.

seconds

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

Длительность времени с точностью до секунды. Значение должно находиться в диапазоне от 0 до 315 576 000 000 включительно.

consecutive_errors

integer

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

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

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

consecutive_gateway_failure

integer

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

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

enforcing_consecutive_errors

integer

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

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

enforcing_consecutive_gateway_failure

integer

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

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

enforcing_success_rate

integer

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

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

interval

dictionary

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

nanos

integer

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

seconds

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

Длительность времени с точностью до секунды. Значение должно находиться в диапазоне от 0 до 315 576 000 000 включительно.

max_ejection_percent

integer

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

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

success_rate_minimum_hosts

integer

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

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

success_rate_request_volume

integer

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

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

success_rate_stdev_factor

integer

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

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

port_name

string

Именованный порт в группе экземпляров серверной части, представляющий порт для связи с виртуальными машинами этой группы. Обязателен, если для loadBalancingScheme задано значение EXTERNAL, INTERNAL_MANAGED или INTERNAL_SELF_MANAGED, а серверными частями являются группы экземпляров. Именованный порт должен быть определён в каждой группе экземпляров серверной части. Этот параметр не имеет значения, если серверными частями являются NEG. Если значение не задано, API устанавливает значение по умолчанию “http”.

Необходимо опустить, если для loadBalancingScheme задано значение INTERNAL (внутренняя балансировка нагрузки TCP/UDP).

project

string

Проект Google Cloud Platform, который необходимо использовать.

protocol

string

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

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

Допустимые варианты: “HTTP”, “HTTPS”, “HTTP2”, “SSL”, “TCP”, “UDP”, “GRPC”

region

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

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

scopes

list / elements=string

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

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

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

session_affinity

string

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

Допустимые варианты: “NONE”, “CLIENT_IP”, “CLIENT_IP_PORT_PROTO”, “CLIENT_IP_PROTO”, “GENERATED_COOKIE”, “HEADER_FIELD”, “HTTP_COOKIE”

state

string

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

Варианты:

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

timeout_sec

integer

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

affinityCookieTtlSec

integer

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

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

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

backends

complex

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

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

balancingMode

string

Задает режим балансировки для этой серверной части.

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

capacityScaler

string

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

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

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

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

description

string

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

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

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

failover

boolean

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

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

group

string

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

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

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

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

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

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

maxConnections

integer

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

Не может быть задано для серверных служб INTERNAL.

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

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

maxConnectionsPerEndpoint

integer

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

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

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

maxConnectionsPerInstance

integer

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

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

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

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

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

maxRate

integer

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

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

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

maxRatePerEndpoint

string

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

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

maxRatePerInstance

string

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

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

maxUtilization

string

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

Не может быть задано для серверных служб INTERNAL.

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

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; один и тот же код состояния нельзя указать более одного раза.

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

serveWhileStale

integer

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

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

signedUrlCacheMaxAgeSec

integer

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

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

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

circuitBreakers

complex

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

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

maxConnections

integer

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

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

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

maxPendingRequests

integer

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

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

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

maxRequests

integer

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

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

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

maxRequestsPerConnection

integer

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

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

maxRetries

integer

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

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

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

connectionDraining

complex

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

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

drainingTimeoutSec

integer

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

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

consistentHash

complex

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

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

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

httpCookie

complex

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

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

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

name

string

Имя файла cookie.

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

path

string

Путь, задаваемый для файла cookie.

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

ttl

complex

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

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

nanos

integer

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

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

seconds

integer

Длительность с точностью до секунды.

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

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

httpHeaderName

string

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

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

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

minimumRingSize

integer

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

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

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

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

creationTimestamp

string

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

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

description

string

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

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

enableCDN

boolean

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

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

failoverPolicy

complex

Политика переключения при сбое.

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

disableConnectionDrainOnFailover

boolean

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

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

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

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

dropTrafficIfUnhealthy

boolean

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

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

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

failoverRatio

string

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

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

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

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

fingerprint

string

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

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

healthChecks

list / elements=string

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

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

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

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_MANAGED, а для `protocol` — HTTP, HTTPS или HTTP2.

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

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])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис.

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

network

dictionary

URL сети, к которой относится эта серверная служба.

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

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

outlierDetection

complex

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

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

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

baseEjectionTime

complex

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

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

nanos

integer

Длительность, составляющая долю секунды и выраженная с точностью до наносекунд. Длительность менее одной секунды представляется полем `seconds` со значением 0 и положительным значением поля `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

Длительность, составляющая долю секунды и выраженная с точностью до наносекунд. Длительность менее одной секунды представляется полем `seconds` со значением 0 и положительным значением поля `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

Именованный порт группы экземпляров, представляющий порт для связи с виртуальными машинами этой группы. Обязателен, если для loadBalancingScheme задано значение EXTERNAL, INTERNAL_MANAGED или INTERNAL_SELF_MANAGED, а в качестве серверных ресурсов используются группы экземпляров. Именованный порт должен быть определен в каждой группе серверных экземпляров. Этот параметр не имеет значения, если в качестве серверных ресурсов используются NEG. Если параметр не задан, API устанавливает значение по умолчанию “http”.

Необходимо опустить, если для loadBalancingScheme задано значение INTERNAL (внутренняя балансировка нагрузки TCP/UDP).

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

protocol

string

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

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

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

region

string

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

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

sessionAffinity

string

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

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

timeoutSec

integer

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

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