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

resources

complex

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

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

affinityCookieTtlSec

integer

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

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

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

backends

complex

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

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

balancingMode

string

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

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

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

capacityScaler

string

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

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

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

description

string

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

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

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

group

string

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

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

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

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

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

maxConnections

integer

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

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

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

maxConnectionsPerEndpoint

integer

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

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

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

maxConnectionsPerInstance

integer

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

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

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

maxRate

integer

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

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

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

maxRatePerEndpoint

string

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

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

maxRatePerInstance

string

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

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

maxUtilization

string

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

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

cdnPolicy

complex

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

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

cacheKeyPolicy

complex

CacheKeyPolicy для этой CdnPolicy.

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

includeHost

boolean

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

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

includeProtocol

boolean

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

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

includeQueryString

boolean

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

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

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

queryStringBlacklist

list / elements=string

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

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

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

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

queryStringWhitelist

list / elements=string

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

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

Символы «&» и «=» будут кодироваться в процентном формате и не будут обрабатываться как разделители.

Возвращено: 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

ttl

integer

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

Возвращено: 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_SELF_MANAGED.

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

maxConnections

integer

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

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

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

maxPendingRequests

integer

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

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

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

maxRequests

integer

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

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

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

maxRequestsPerConnection

integer

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

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

maxRetries

integer

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

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

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

connectionDraining

complex

Параметры для удаления соединений.

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

drainingTimeoutSec

integer

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

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

consistentHash

complex

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

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

httpCookie

complex

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

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

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

name

string

Имя cookie.

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

path

string

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

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

ttl

complex

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

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

nanos

integer

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

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

seconds

integer

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

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

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

httpHeaderName

string

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

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

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

minimumRingSize

integer

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

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

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

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

creationTimestamp

string

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

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

customRequestHeaders

list / elements=string

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

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

customResponseHeaders

list / elements=string

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

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

description

string

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

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

enableCDN

boolean

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

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

fingerprint

string

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

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

healthChecks

list / elements=string

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

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

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

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

iap

complex

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

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

enabled

boolean

Включает IAP.

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

oauth2ClientId

string

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

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

oauth2ClientSecret

string

Секретный ключ клиента OAuth2 для IAP.

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

oauth2ClientSecretSha256

string

SHA-256 секретного ключа клиента OAuth2 для IAP.

Возвращено: 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_SELF_MANAGED.

Возвращено: 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

outlierDetection

complex

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

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

Возвращено: 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

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

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

protocol

string

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

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

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

securityPolicy

string

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

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

sessionAffinity

string

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

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

timeoutSec

integer

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

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