Модуль google.cloud.gcp_compute_region_backend_service_info – Сбор информации о GCP RegionBackendService

resources

complex

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

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

affinityCookieTtlSec

integer

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

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

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

backends

complex

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

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

balancingMode

string

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

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

capacityScaler

string

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

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

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

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

description

string

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

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

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

failover

boolean

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

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

group

string

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

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

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

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

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

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

maxConnections

integer

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

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

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

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

maxConnectionsPerEndpoint

integer

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

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

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

maxConnectionsPerInstance

integer

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

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

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

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

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

maxRate

integer

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

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

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

maxRatePerEndpoint

string

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

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

maxRatePerInstance

string

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

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

maxUtilization

string

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

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

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

cdnPolicy

complex

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

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

cacheKeyPolicy

complex

CacheKeyPolicy для этой 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 (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

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

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

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

circuitBreakers

complex

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

Returned: success

maxConnections

integer

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

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

Returned: 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.

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

description

string

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

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

enableCDN

boolean

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

Возвращается: 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» не установлен или все виртуальные машины в резервном бэкенде неисправны, трафик будет направлен обратно в основной бэкенд в режиме «принуждения», где трафик будет распределяться по исправным виртуальным машинам с наилучшими усилиями или всем виртуальным машинам, когда ни одна виртуальная машина неисправна.

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

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

fingerprint

string

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

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

healthChecks

list / elements=string

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

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

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

id

integer

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

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

loadBalancingScheme

string

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

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

localityLbPolicy

string

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

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

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

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

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

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

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

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

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

logConfig

complex

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

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

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

enable

boolean

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

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

sampleRate

string

Это поле может быть указано только в том случае, если ведение журнала включено для этой службы back-end. Значение поля должно быть в [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

Количество ошибок, прежде чем хост будет исключен из пула подключений. Когда к хосту backend осуществляется доступ по протоколу 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

целое число

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

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

successRateStdevFactor

целое число

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

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

portName

строка

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

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

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

protocol

строка

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

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

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

region

строка

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

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

sessionAffinity

строка

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

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

timeoutSec

целое число

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

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