google.cloud.gcp_compute_region_url_map_info – Сбор информации о GCP RegionUrlMap
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в плейбуке укажите: google.cloud.gcp_compute_region_url_map_info.
Обзор
- Сбор информации о GCP RegionUrlMap
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это не нужно устанавливать, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов к API. | |
| filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| region строка / обязательно | Ссылка на регион, в котором находится url-карта. | |
| scopes список / элементы=строка | Массив используемых областей | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как JSON-строка, которая его представляет. | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- для аутентификации можно установить service_account_file, используя переменную среды
gcp_service_account_file. - для аутентификации можно установить service_account_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - значения переменных среды будут использоваться только в том случае, если значения плейбука не заданы.
- параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on a region URL map
gcp_compute_region_url_map_info:
region: us-central1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |||||||
|---|---|---|---|---|---|---|---|---|---|
| resources complex | всегда | Список ресурсов | |||||||
| creationTimestamp string | успех | Отметка времени создания в формате RFC3339. | |||||||
| defaultService dictionary | успех | Полный или частичный URL ресурса defaultService, на который направляется трафик, если ни одно из правил hostRules не совпадает. Если дополнительно указан defaultRouteAction, выполняются дополнительные действия маршрутизации, такие как перенаправление URL и т. д., прежде чем запрос будет отправлен на бэкенд. Однако, если указан defaultService, defaultRouteAction не может содержать какие-либо weightedBackendServices. И наоборот, если routeAction содержит какие-либо weightedBackendServices, service не должен быть указан. Только один из defaultService, defaultUrlRedirect или defaultRouteAction.weightedBackendService должен быть задан. | |||||||
| defaultUrlRedirect complex | успех | Если ни одно из указанных hostRules не совпадает, запрос перенаправляется на URL, указанный в defaultUrlRedirect. Если указан defaultUrlRedirect, defaultService или defaultRouteAction не должны быть заданы. | |||||||
| hostRedirect string | успех | Хост, который будет использоваться в ответе о перенаправлении вместо хоста, предоставленного в запросе. Значение должно быть от 1 до 255 символов. | |||||||
| httpsRedirect boolean | успех | Если установлено в true, схема URL в перенаправленном запросе устанавливается в https. Если установлено в false, схема URL перенаправленного запроса остаётся такой же, как и в запросе. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка в true для TargetHttpsProxy запрещена. По умолчанию установлено в false. | |||||||
| pathRedirect string | успех | Путь, который будет использоваться в ответе о перенаправлении вместо пути, предоставленного в запросе. pathRedirect не может быть указан вместе с prefixRedirect. Указывается только один из них или ни один. Если ни один не указан, путь исходного запроса будет использован для перенаправления. Значение должно быть от 1 до 1024 символов. | |||||||
| prefixRedirect string | успех | Префикс, который заменяет prefixMatch, указанный в HttpRouteRuleMatch, сохраняя остальную часть URL перед перенаправлением запроса. prefixRedirect не может быть указан вместе с pathRedirect. Указывается только один из них или ни один. Если ни один не указан, путь исходного запроса будет использован для перенаправления. Значение должно быть от 1 до 1024 символов. | |||||||
| redirectResponseCode string | успех | HTTP-код состояния, который будет использоваться для этого действия перенаправления. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT — значение по умолчанию, соответствует 301. * FOUND — соответствует 302. * SEE_OTHER — соответствует 303. * TEMPORARY_REDIRECT — соответствует 307. В этом случае метод запроса сохраняется. * PERMANENT_REDIRECT — соответствует 308. В этом случае метод запроса сохраняется. | |||||||
| stripQuery boolean | успех | Если установлено в true, любая часть запроса в исходном URL удаляется перед перенаправлением запроса. Если установлено в false, часть запроса исходного URL сохраняется. | |||||||
| description string | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |||||||
| fingerprint string | успех | Отпечаток этого ресурса. Это поле используется во время обновлений ресурса. | |||||||
| hostRules complex | успех | Список HostRules для использования с URL. | |||||||
| description string | успех | Необязательное описание этого HostRule. Укажите это свойство при создании ресурса. | |||||||
| hosts list / elements=string | успех | Список шаблонов хостов для сопоставления. Они должны быть валидными именами хостов, за исключением * который сопоставляется с любой строкой ([a-z0-9-.]*). В этом случае * должен быть первым символом и должен быть за ним в шаблоне - или . | |||||||
| pathMatcher string | успех | Имя PathMatcher, используемого для сопоставления пути части URL, если hostRule совпадает с частью хоста URL. | |||||||
| id integer | успех | Уникальный идентификатор ресурса. | |||||||
| name string | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |||||||
| pathMatchers complex | успех | Список именованных PathMatchers для использования с URL. | |||||||
| defaultService dictionary | успех | Ссылка на ресурс RegionBackendService. Будет использоваться, если ни одно из pathRules, определённых этим PathMatcher, не соответствует пути части URL. | |||||||
| defaultUrlRedirect complex | успех | Если ни одно из указанных hostRules не совпадает, запрос перенаправляется на URL, указанный в defaultUrlRedirect. Если указан defaultUrlRedirect, defaultService или defaultRouteAction не должны быть заданы. | |||||||
| hostRedirect string | успех | Хост, который будет использоваться в ответе о перенаправлении вместо хоста, предоставленного в запросе. Значение должно быть от 1 до 255 символов. | |||||||
| httpsRedirect boolean | успех | Если установлено в true, схема URL в перенаправленном запросе устанавливается в https. Если установлено в false, схема URL перенаправленного запроса остаётся такой же, как и в запросе. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка в true для TargetHttpsProxy запрещена. По умолчанию установлено в false. | |||||||
| pathRedirect string | успех | Путь, который будет использоваться в ответе о перенаправлении вместо пути, предоставленного в запросе. pathRedirect не может быть указан вместе с prefixRedirect. Указывается только один из них или ни один. Если ни один не указан, путь исходного запроса будет использован для перенаправления. Значение должно быть от 1 до 1024 символов. | |||||||
| prefixRedirect string | успех | Префикс, который заменяет prefixMatch, указанный в HttpRouteRuleMatch, сохраняя остальную часть URL перед перенаправлением запроса. prefixRedirect не может быть указан вместе с pathRedirect. Указывается только один из них или ни один. Если ни один не указан, путь исходного запроса будет использован для перенаправления. Значение должно быть от 1 до 1024 символов. | |||||||
| redirectResponseCode string | успех | HTTP-код состояния, который будет использоваться для этого действия перенаправления. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT — значение по умолчанию, соответствует 301. * FOUND — соответствует 302. * SEE_OTHER — соответствует 303. * TEMPORARY_REDIRECT — соответствует 307. В этом случае метод запроса сохраняется. * PERMANENT_REDIRECT — соответствует 308. В этом случае метод запроса сохраняется. | |||||||
| stripQuery boolean | успех | Если установлено в true, любая часть запроса в исходном URL удаляется перед перенаправлением запроса. Если установлено в false, часть запроса исходного URL сохраняется. | |||||||
| description string | успех | Необязательное описание этого ресурса. | |||||||
| имя строка | успех | Имя, по которому этот PathMatcher упоминается в HostRule. | |||||||
| pathRules сложное | успех | Список правил пути. Используйте этот список вместо routeRules, когда требуется только маршрутизация на основе простого сопоставления путей. Порядок указания правил пути не имеет значения. Сопоставление всегда выполняется по принципу «самый длинный путь в первую очередь». Например: pathRule с путём /a/b/c/* будет соответствовать перед /a/b/* независимо от порядка, в котором эти пути появляются в этом списке. В рамках заданного pathMatcher должен быть установлен только один из pathRules или routeRules. | |||||||
| пути список / элементы=строка | успех | Список шаблонов путей для сопоставления. Каждый должен начинаться с /, и единственное место, где разрешено использование *, находится в конце после /. Строка, передаваемая в path matcher, не включает текст после первого ? или #, и эти символы здесь недопустимы. | |||||||
| routeAction сложное | успех | В ответ на сопоставленный путь балансировщик нагрузки выполняет расширенные действия маршрутизации, такие как перенаправление URL, преобразование заголовков и т. д., прежде чем пересылать запрос выбранному бэкенду. Если routeAction указывает какие-либо weightedBackendServices, service не должен быть установлен. И наоборот, если service установлен, routeAction не может содержать какие-либо weightedBackendServices. Должен быть установлен только один из routeAction или urlRedirect. | |||||||
| corsPolicy сложное | успех | Спецификация для разрешения кросс-доменных запросов со стороны клиента. Пожалуйста, см. рекомендацию W3C по кросс-доменному обмену ресурсами. | |||||||
| allowCredentials булево | успех | В ответ на запрос префлайта, установка этого значения в true указывает, что фактический запрос может включать учетные данные пользователя. Это переводится в заголовок Access-Control-Allow-Credentials. По умолчанию значение false. | |||||||
| allowHeaders список / элементы=строка | успех | Указывает содержимое заголовка Access-Control-Allow-Headers. | |||||||
| allowMethods список / элементы=строка | успех | Указывает содержимое заголовка Access-Control-Allow-Methods. | |||||||
| allowOriginRegexes список / элементы=строка | успех | Указывает шаблоны регулярных выражений, которые соответствуют разрешенным источникам. Для грамматики регулярных выражений, пожалуйста, см. en.cppreference.com/w/cpp/regex/ecmascript. Источник разрешен, если он соответствует либо allow_origins, либо allow_origin_regex. | |||||||
| allowOrigins список / элементы=строка | успех | Указывает список источников, которым будет разрешено выполнять запросы CORS. Источник разрешен, если он соответствует либо allow_origins, либо allow_origin_regex. | |||||||
| disabled булево | успех | Если true, указывает, что политика CORS отключена. | |||||||
| exposeHeaders список / элементы=строка | успех | Указывает содержимое заголовка Access-Control-Expose-Headers. | |||||||
| maxAge целое число | успех | Указывает, как долго результаты запроса префлайта могут кешироваться. Это отражается в содержимом заголовка Access-Control-Max-Age. | |||||||
| faultInjectionPolicy сложное | успех | Спецификация для введения сбоев в трафик, чтобы проверить устойчивость клиентов к отказам бэкенд-службы. В рамках введения сбоев, когда клиенты отправляют запросы бэкенд-службе, Loadbalancer может вводить задержки в проценте запросов перед отправкой этих запросов на бэкенд-службу. Аналогичным образом, запросы от клиентов могут прерываться Loadbalancer для процента запросов. timeout и retry_policy будут игнорироваться клиентами, настроенными с fault_injection_policy. | |||||||
| abort сложное | успех | Спецификация того, как запросы клиентов прерываются в рамках введения сбоев. | |||||||
| httpStatus целое число | успех | Код HTTP-статуса, используемый для прерывания запроса. Значение должно быть включительно от 200 до 599. | |||||||
| percentage строка | успех | Процент трафика (соединений/операций/запросов), который будет прерван в рамках введения сбоев. Значение должно быть включительно от 0.0 до 100.0. | |||||||
| delay сложное | успех | Спецификация того, как запросы клиентов задерживаются в рамках введения сбоев перед отправкой их на бэкенд-службу. | |||||||
| nanos целое число | успех | Продолжительность, являющаяся дробью секунды с разрешением в наносекунды. Продолжительности меньше одной секунды представлены с полем `seconds`, равным 0, и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно. | |||||||
| seconds строка | успех | Продолжительность с разрешением в секунду. Должно быть от 0 до 315 576 000 000 включительно. | |||||||
| percentage строка | успех | Процент трафика (соединений/операций/запросов), на котором будет введена задержка в рамках введения сбоев. Значение должно быть включительно от 0.0 до 100.0. | |||||||
| requestMirrorPolicy сложное | успех | Указывает политику того, как запросы, предназначенные для бэкендов маршрута, дублируются на отдельной зеркальной бэкенд-службе. Loadbalancer не ждет ответов от зеркальной службы. Перед отправкой трафика на зеркальную службу заголовок хоста/авторитета дополняется -shadow. | |||||||
| backendService словарь | успех | Ресурс RegionBackendService, который будет дублироваться. | |||||||
| retryPolicy complex | success | Указывает политику повторных попыток, связанную с этим маршрутом. | |||||||
| numRetries integer | success | Указывает разрешенное количество попыток повтора. Это число должно быть > 0. | |||||||
| perTryTimeout complex | success | Указывает ненулевой тайм-аут на каждую попытку повтора. | |||||||
| nanos integer | success | Продолжительность, которая является дробной частью секунды с разрешением в наносекунды. Продолжительности, меньшие одной секунды, представлены полем `seconds` со значением 0 и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно. | |||||||
| seconds string | success | Продолжительность с разрешением в секунды. Должно быть от 0 до 315 576 000 000 включительно. | |||||||
| retryConditions list / elements=string | success | Указывает один или несколько условий, когда применяется это правило повторной попытки. Допустимые значения: - 5xx: Loadbalancer предпримет повторную попытку, если служба бэкенда ответит любым кодом ответа 5xx или вообще не ответит, например, при отключении, сбросе, тайм-ауте чтения, сбое соединения и отказе потоков. - gateway-error: Аналогично 5xx, но применяется только к кодам ответа 502, 503 или 504. - connect-failure: Loadbalancer предпримет повторную попытку при сбоях подключения к службам бэкенда, например, из-за тайм-аутов подключения. - retriable-4xx: Loadbalancer предпримет повторную попытку для исправленных кодов ответа 4xx. В настоящее время поддерживается только одна исправленная ошибка 409. - refused-stream: Loadbalancer предпримет повторную попытку, если служба бэкенда сбросит поток с кодом ошибки REFUSED_STREAM. Этот тип сброса указывает, что повторная попытка безопасна. - cancelled: Loadbalancer предпримет повторную попытку, если код состояния gRPC в заголовке ответа установлен в cancelled - deadline-exceeded: Loadbalancer предпримет повторную попытку, если код состояния gRPC в заголовке ответа установлен в deadline-exceeded - resource-exhausted: Loadbalancer предпримет повторную попытку, если код состояния gRPC в заголовке ответа установлен в resource-exhausted - unavailable: Loadbalancer предпримет повторную попытку, если код состояния gRPC в заголовке ответа установлен в unavailable. | |||||||
| timeout complex | success | Указывает тайм-аут для выбранного маршрута. Тайм-аут вычисляется с момента полного обработки запроса (т. е. конца потока) до момента полной обработки ответа. Тайм-аут включает все повторные попытки. Если не указано, значение по умолчанию составляет 15 секунд. | |||||||
| nanos integer | success | Продолжительность, которая является дробной частью секунды с разрешением в наносекунды. Продолжительности, меньшие одной секунды, представлены полем `seconds` со значением 0 и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно. | |||||||
| seconds string | success | Продолжительность с разрешением в секунды. Должно быть от 0 до 315 576 000 000 включительно. | |||||||
| urlRewrite complex | success | Спецификация для изменения URL запроса перед переадресацией запроса на сопоставленную службу. | |||||||
| hostRewrite string | success | Перед переадресацией запроса на выбранную службу заголовок хоста запроса заменяется содержимым hostRewrite. Значение должно быть от 1 до 255 символов. | |||||||
| pathPrefixRewrite string | success | Перед переадресацией запроса на выбранную службу бэкенда соответствующая часть пути запроса заменяется на pathPrefixRewrite. Значение должно быть от 1 до 1024 символов. | |||||||
| weightedBackendServices complex | success | Список взвешенных служб бэкенда, которым нужно отправлять трафик при совпадении маршрута. Веса определяют долю трафика, направляемого на соответствующую службу бэкенда. Если весь трафик должен идти на одну службу бэкенда, должна быть одна weightedBackendService с весом, отличным от 0. После определения службы бэкенда и перед переадресацией запроса на службу бэкенда применяются расширенные действия маршрутизации, такие как переписывание URL и преобразование заголовков, в зависимости от дополнительных параметров, указанных в этом HttpRouteAction. | |||||||
| backendService dictionary | success | Ресурс RegionBackendService по умолчанию. Перед переадресацией запроса на backendService балансировщик приложений применяет все соответствующие действия с заголовками, указанные в рамках этого backendServiceWeight. | |||||||
| headerAction complex | success | Указывает изменения в заголовках запросов и ответов, которые должны вступить в силу для выбранной службы бэкенда. headerAction, указанные здесь, действуют до headerAction в охватывающей HttpRouteRule, PathMatcher и UrlMap. | |||||||
| requestHeadersToAdd complex | success | Заголовки, которые нужно добавить в соответствующий запрос перед переадресацией запроса на backendService. | |||||||
| headerName string | success | Имя заголовка. | |||||||
| headerValue string | success | Значение добавляемого заголовка. | |||||||
| replace boolean | success | Если false, headerValue добавляется к уже существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, удаляя любые ранее установленные значения этого заголовка. | |||||||
| requestHeadersToRemove list / elements=string | success | Список имен заголовков, которые нужно удалить из запроса перед переадресацией запроса на backendService. | |||||||
| responseHeadersToAdd complex | success | Заголовки, которые нужно добавить в ответ перед отправкой ответа клиенту. | |||||||
| headerName string | success | Имя заголовка. | |||||||
| headerValue string | success | Значение заголовка для добавления. | |||||||
| replace boolean | success | Если false, headerValue добавляется к существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, удаляя предыдущие значения. | |||||||
| responseHeadersToRemove list / elements=string | success | Список имён заголовков, которые нужно удалить из ответа перед его отправкой клиенту. | |||||||
| weight integer | success | Указывает долю трафика, отправляемого в backendService, вычисляемую как weight / (сумма весов всех weightedBackendService в routeAction). Выбор backend service определяется только для нового трафика. После того, как запрос пользователя был перенаправлен в backendService, последующие запросы будут отправлены в тот же backendService, как определено политикой affinity сессии BackendService. Значение должно быть между 0 и 1000. | |||||||
| service dictionary | success | Ресурс backend service в регионе, которому направляется трафик, если это правило соответствует. Если routeAction также указан, применяются дополнительные действия маршрутизации, такие как перенаправление URL и т. д., перед отправкой запроса в backend. Однако, если service указан, routeAction не может содержать weightedBackendService. И наоборот, если routeAction указывает weightedBackendServices, service не должен быть указан. Только один из urlRedirect, service или routeAction.weightedBackendService должен быть задан. | |||||||
| urlRedirect complex | success | При соответствии шаблону пути запрос перенаправляется на URL, указанный в urlRedirect. Если urlRedirect указан, service или routeAction не должны быть заданы. | |||||||
| hostRedirect string | success | Хост, который будет использоваться в ответе с перенаправлением вместо того, который был предоставлен в запросе. Значение должно быть между 1 и 255 символами. | |||||||
| httpsRedirect boolean | success | Если установлено в true, схема URL в перенаправленном запросе устанавливается в https. Если установлено в false, схема URL перенаправленного запроса останется такой же, как и в запросе. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка в true для TargetHttpsProxy запрещена. По умолчанию установлено в false. | |||||||
| pathRedirect string | success | Путь, который будет использоваться в ответе с перенаправлением вместо пути, предоставленного в запросе. pathRedirect не может быть предоставлен вместе с prefixRedirect. Используйте либо тот, либо другой, или ни того, ни другого. Если ни тот, ни другой не предоставлены, путь исходного запроса будет использован для перенаправления. Значение должно быть между 1 и 1024 символами. | |||||||
| prefixRedirect string | success | Префикс, который заменяет префиксMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL перед перенаправлением запроса. prefixRedirect не может быть предоставлен вместе с pathRedirect. Используйте либо тот, либо другой, или ни того, ни другого. Если ни тот, ни другой не предоставлены, путь исходного запроса будет использован для перенаправления. Значение должно быть между 1 и 1024 символами. | |||||||
| redirectResponseCode string | success | HTTP код состояния, используемый для этого RedirectAction. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT (по умолчанию), соответствующий 301. * FOUND, соответствующий 302. * SEE_OTHER, соответствующий 303. * TEMPORARY_REDIRECT, соответствующий 307. В этом случае метод запроса сохраняется. * PERMANENT_REDIRECT, соответствующий 308. В этом случае метод запроса сохраняется. | |||||||
| stripQuery boolean | success | Если установлено в true, любая сопровождающая часть запроса исходного URL удаляется перед перенаправлением запроса. Если установлено в false, часть запроса исходного URL сохраняется. | |||||||
| routeRules complex | success | Список упорядоченных правил маршрутизации HTTP. Используйте этот список вместо pathRules, когда требуется продвинутое сопоставление маршрутов и действия маршрутизации. Порядок указания routeRules имеет значение: первое совпавшее правило вызовет действие маршрутизации. В рамках pathMatcher должен быть задан только один из pathRules или routeRules. routeRules не поддерживаются в UrlMaps, предназначенных для внешних балансировщиков нагрузки. | |||||||
| headerAction complex | success | Указывает изменения в заголовках запроса и ответа, которые должны быть применены для выбранного backendService. headerAction, указанные здесь, применяются перед matching pathMatchers[].headerAction и после pathMatchers[].routeRules[].r outeAction.weightedBackendService.backendServiceWeightAction[].headerAction. | |||||||
| requestHeadersToAdd complex | success | Заголовки, которые нужно добавить в соответствующий запрос перед пересылкой его в backendService. | |||||||
| headerName string | success | Имя заголовка. | |||||||
| headerValue string | success | Значение заголовка для добавления. | |||||||
| replace boolean | success | Если false, headerValue добавляется к существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, удаляя предыдущие значения. | |||||||
| requestHeadersToRemove list / elements=string | success | Список имён заголовков, которые нужно удалить из запроса перед пересылкой его в backendService. | |||||||
| responseHeadersToAdd complex | success | Заголовки, которые нужно добавить в ответ перед отправкой его клиенту. | |||||||
| headerName string | success | Имя заголовка. | |||||||
| headerValue string | success | Значение заголовка для добавления. | |||||||
| replace boolean | success | Если false, headerValue добавляется к существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, удаляя предыдущие значения. | |||||||
| responseHeadersToRemove list / elements=string | success | Список имён заголовков, которые нужно удалить из ответа перед отправкой клиенту. | |||||||
| matchRules complex | success | Правила определения соответствия. | |||||||
| fullPathMatch string | success | Для выполнения условия matchRule путь запроса должен точно соответствовать значению в fullPathMatch после удаления параметров запроса и якоря, которые могут быть частью исходного URL. FullPathMatch должен содержать от 1 до 1024 символов. Только один из prefixMatch, fullPathMatch или regexMatch должен быть указан. | |||||||
| headerMatches complex | success | Указывает список критериев соответствия заголовков, все из которых должны соответствовать соответствующим заголовкам в запросе. | |||||||
| exactMatch string | success | Значение должно точно соответствовать содержимому exactMatch. Только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch должен быть задан. | |||||||
| headerName string | success | Имя HTTP-заголовка для сопоставления. Для сопоставления с авторитетом HTTP-запроса используйте headerMatch со значением headerName ":authority". Для сопоставления метода запроса используйте headerName ":method". | |||||||
| invertMatch boolean | success | Если установлено в false, headerMatch считается соответствием, если вышеуказанные критерии соответствия выполнены. Если установлено в true, headerMatch считается соответствием, если критерии соответствия ВЫШЕУКАЗАННЫЕ НЕ выполнены. По умолчанию false. | |||||||
| prefixMatch string | success | Значение заголовка должно начинаться с содержимого prefixMatch. Только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch должен быть задан. | |||||||
| presentMatch boolean | success | Заголовок со значением headerName должен существовать. Сопоставление происходит, независимо от того, имеет ли заголовок запроса значение или нет. Только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch должен быть задан. | |||||||
| rangeMatch complex | success | Значение заголовка должно быть целым числом и находиться в диапазоне, указанном в rangeMatch. Если заголовок не содержит целого числа, числа или пустой, сопоставление не выполняется. Например, для диапазона [-5, 0]: * -3 соответствует * 0 не соответствует * 0.25 не соответствует * -3someString не соответствует. Только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch должен быть задан. | |||||||
| rangeEnd integer | success | Конец диапазона (исключительно). | |||||||
| rangeStart integer | success | Начало диапазона (включительно). | |||||||
| regexMatch string | success | Значение заголовка должно соответствовать регулярному выражению, указанному в regexMatch. Для грамматики регулярных выражений см.: en.cppreference.com/w/cpp/regex/ecmascript Для сопоставления с портом, указанным в HTTP-запросе, используйте headerMatch со значением headerName PORT и регулярное выражение, соответствующее спецификатору порта заголовка Host в RFC2616. Только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch должен быть задан. | |||||||
| suffixMatch string | success | Значение заголовка должно заканчиваться содержимым suffixMatch. Только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch должен быть задан. | |||||||
| ignoreCase boolean | success | Указывает, что сопоставления prefixMatch и fullPathMatch регистрозависимые. По умолчанию false. | |||||||
| metadataFilters complex | success | Непрозрачные критерии фильтрации, используемые Loadbalancer для ограничения конфигурации маршрутизации до ограниченного набора xDS-совместимых клиентов. В своих xDS-запросах к Loadbalancer xDS-клиенты предоставляют метаданные узла. Если совпадение происходит, соответствующая конфигурация маршрутизации становится доступной для этих прокси-серверов. Для каждого metadataFilter в этом списке, если его filterMatchCriteria установлено в MATCH_ANY, хотя бы один из filterLabels должен совпадать с соответствующей меткой, предоставленной в метаданных. Если filterMatchCriteria установлено в MATCH_ALL, то все его filterLabels должны совпадать с соответствующими метками в предоставленных метаданных. metadataFilters, указанные здесь, могут переопределять те, которые указаны в ForwardingRule, относящемся к этой UrlMap. metadataFilters применяются только к Loadbalancer, у которых loadBalancingScheme установлено в INTERNAL_SELF_MANAGED. | |||||||
| filterLabels complex | success | Список пар значений меток, которые должны совпадать с метками в предоставленных метаданных на основе filterMatchCriteria. Этот список не должен быть пустым и может содержать не более 64 элементов. | |||||||
| name string | success | Имя метки метаданных. Имя может иметь максимальную длину 1024 символа и должно иметь длину не менее 1 символа. | |||||||
| value string | success | Значение метки должно совпадать с указанным значением. значение может иметь максимальную длину 1024 символа. | |||||||
| filterMatchCriteria string | success | Указывает, как отдельные сопоставления filterLabel в списке filterLabels влияют на общее совпадение metadataFilter. Доступные значения: * MATCH_ANY: хотя бы одна из меток filterLabels должна иметь соответствующую метку в предоставленных метаданных. * MATCH_ALL: все filterLabels должны иметь соответствующие метки в предоставленных метаданных. | |||||||
| prefixMatch string | success | Для выполнения условия matchRule путь запроса должен начинаться с указанного prefixMatch. prefixMatch должен начинаться с /. Значение должно быть от 1 до 1024 символов. Только один из prefixMatch, fullPathMatch или regexMatch должен быть указан. | |||||||
| queryParameterMatches complex | success | Указывает список критериев соответствия параметров запроса, все из которых должны соответствовать соответствующим параметрам запроса. | |||||||
| exactMatch строка | success | Сопоставление queryParameterMatch происходит, если значение параметра точно совпадает с содержимым exactMatch. Только одно из presentMatch, exactMatch и regexMatch должно быть установлено. | |||||||
| name строка | success | Имя параметра запроса для сопоставления. Параметр запроса должен существовать в запросе, в противном случае сопоставление запроса завершится неудачей. | |||||||
| presentMatch логическое | success | Указывает, что queryParameterMatch совпадает, если запрос содержит параметр запроса, независимо от того, имеет ли параметр значение или нет. Только одно из presentMatch, exactMatch и regexMatch должно быть установлено. | |||||||
| regexMatch строка | success | Сопоставление queryParameterMatch происходит, если значение параметра соответствует регулярному выражению, указанному в regexMatch. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript. Только одно из presentMatch, exactMatch и regexMatch должно быть установлено. | |||||||
| regexMatch строка | success | Для удовлетворения условия matchRule путь запроса должен соответствовать регулярному выражению, указанному в regexMatch, после удаления всех параметров запроса и якорей, предоставленных в исходном URL-адресе. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript. Только одно из prefixMatch, fullPathMatch или regexMatch должно быть указано. | |||||||
| priority целое число | success | Для правил маршрутизации (routeRules) в заданном pathMatcher приоритет определяет порядок интерпретации правил маршрутизации балансировщиком нагрузки. Правила маршрутизации оцениваются в порядке приоритета, от наименьшего к наибольшему числу. Приоритет правила уменьшается по мере увеличения его номера (1, 2, 3, N+1). Первое правило, соответствующее запросу, применяется. Нельзя настроить два или более routeRules с одинаковым приоритетом. Приоритет каждого правила должен быть установлен на число от 0 до 2147483647 включительно. Номера приоритетов могут иметь пробелы, что позволяет добавлять или удалять правила в будущем без влияния на остальные правила. Например, 1, 2, 3, 4, 5, 9, 12, 16 — это допустимый ряд номеров приоритетов, к которому вы можете добавить правила с номерами от 6 до 8, от 10 до 11 и от 13 до 15 в будущем без каких-либо последствий для существующих правил. | |||||||
| routeAction сложный | success | В ответ на сопоставленное matchRule балансировщик нагрузки выполняет расширенные действия маршрутизации, такие как переписывание URL-адресов, преобразование заголовков и т. д., перед передачей запроса выбранному бэкенду. Если routeAction указывает какие-либо weightedBackendServices, сервис не должен быть установлен. И наоборот, если сервис установлен, routeAction не может содержать weightedBackendServices. Только одно из routeAction или urlRedirect должно быть установлено. | |||||||
| corsPolicy сложный | success | Спецификация для разрешения запросов с перекрестной отправкой с клиентской стороны. См. рекомендацию W3C для совместного использования ресурсов с перекрестным происхождением. | |||||||
| allowCredentials логическое | success | В ответ на запрос префлайта установка этого значения в true указывает, что фактический запрос может включать учетные данные пользователя. Это соответствует заголовку Access-Control-Allow-Credentials. По умолчанию — false. | |||||||
| allowHeaders список / элементы=строка | success | Указывает содержимое заголовка Access-Control-Allow-Headers. | |||||||
| allowMethods список / элементы=строка | success | Указывает содержимое заголовка Access-Control-Allow-Methods. | |||||||
| allowOriginRegexes список / элементы=строка | success | Указывает шаблоны регулярных выражений, которые соответствуют разрешенным источникам. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript. Источник разрешен, если он соответствует либо allow_origins, либо allow_origin_regex. | |||||||
| allowOrigins список / элементы=строка | success | Указывает список источников, которым разрешено выполнять запросы CORS. Источник разрешен, если он соответствует либо allow_origins, либо allow_origin_regex. | |||||||
| disabled логическое | success | Если true, указывает, что политика CORS отключена. что указывает, что политика CORS активна. По умолчанию — false. | |||||||
| exposeHeaders список / элементы=строка | success | Указывает содержимое заголовка Access-Control-Expose-Headers. | |||||||
| maxAge целое число | success | Указывает, как долго результаты запроса префлайта могут храниться в кэше. Это соответствует содержимому заголовка Access-Control-Max-Age. | |||||||
| faultInjectionPolicy сложный | success | Спецификация для введения политики инъекций ошибок в трафик для проверки способности клиентов к устойчивости к отказам бэкенд-сервиса. В рамках инъекции ошибок, когда клиенты отправляют запросы бэкенд-сервису, задержка может быть введена Loadbalancer на проценте запросов перед отправкой этих запросов бэкенд-сервису. Аналогично, запросы от клиентов могут быть прерваны Loadbalancer для процента запросов. timeout и retry_policy будут игнорироваться клиентами, которые настроены с fault_injection_policy. | |||||||
| abort сложный | success | Спецификация для того, как прерываются клиентские запросы в рамках политики инъекций ошибок. | |||||||
| httpStatus целое число | success | Код HTTP-статуса, используемый для прерывания запроса. Значение должно быть в диапазоне от 200 до 599 включительно. | |||||||
| percentage строка | success | Процент трафика (соединений/операций/запросов), который будет прерван в рамках политики инъекций ошибок. Значение должно быть в диапазоне от 0,0 до 100,0 включительно. | |||||||
| delay сложный | success | Спецификация для того, как задерживаются клиентские запросы в рамках политики инъекций ошибок перед отправкой на бэкенд-сервис. | |||||||
| fixedDelay сложный | success | Указывает значение интервала фиксированной задержки. | |||||||
| nanos integer | success | Промежуток времени, который является дробной частью секунды с разрешением в наносекунды. Продолжительности менее одной секунды представлены значением поля `seconds`, равным 0, и положительным значением поля `nanos`. Должно быть в диапазоне от 0 до 999 999 999 включительно. | |||||||
| seconds string | success | Промежуток времени с разрешением в секунды. Должно быть в диапазоне от 0 до 315 576 000 000 включительно. | |||||||
| percentage string | success | Процент трафика (соединений/операций/запросов), на который будет введено замедление как часть инъекции ошибок. Значение должно быть в диапазоне от 0,0 до 100,0 включительно. | |||||||
| requestMirrorPolicy complex | success | Указывает политику того, как запросы, предназначенные для бэкенд-служб маршрута, дублируются в отдельной зеркальной бэкенд-службе. Loadbalancer не ожидает ответов от зеркальной службы. Перед отправкой трафика в зеркальную службу префикс добавляется к заголовку хоста/авторитета -shadow. | |||||||
| backendService dictionary | success | Ресурс RegionBackendService, которому зеркалится трафик. | |||||||
| retryPolicy complex | success | Указывает политику повторных попыток, связанную с этим маршрутом. | |||||||
| numRetries integer | success | Указывает разрешенное количество повторных попыток. Это число должно быть больше 0. | |||||||
| perTryTimeout complex | success | Указывает ненулевой таймаут на каждую попытку повтора. | |||||||
| nanos integer | success | Промежуток времени, который является дробной частью секунды с разрешением в наносекунды. Продолжительности менее одной секунды представлены значением поля `seconds`, равным 0, и положительным значением поля `nanos`. Должно быть в диапазоне от 0 до 999 999 999 включительно. | |||||||
| seconds string | success | Промежуток времени с разрешением в секунды. Должно быть в диапазоне от 0 до 315 576 000 000 включительно. | |||||||
| retryConditions list / elements=string | success | Указывает один или несколько условий, когда применяется данное правило повторной попытки. Допустимые значения: * 5xx: Loadbalancer будет пытаться повторить попытку, если бэкенд-сервис отвечает с любым кодом ответа 5xx, или если бэкенд-сервис вообще не отвечает, например: разъединения, сброс, тайм-аут чтения, ошибка соединения и отказ потоков. * gateway-error: Аналогично 5xx, но применяется только к кодам ответов 502, 503 или 504. * connect-failure: Loadbalancer будет повторять попытки при ошибках подключения к бэкенд-сервисам, например, из-за таймаутов подключения. * retriable-4xx: Loadbalancer будет повторять попытки для исправимых кодов ответа 4xx. В настоящее время единственной поддерживаемой ошибкой для повторной попытки является 409. * refused-stream: Loadbalancer будет повторять попытки, если бэкенд-сервис сбрасывает поток с кодом ошибки REFUSED_STREAM. Этот тип сброса указывает, что можно безопасно повторить попытку. * cancelled: Loadbalancer повторит попытку, если код состояния gRPC в заголовке ответа установлен в отменённый * deadline-exceeded: Loadbalancer повторит попытку, если код состояния gRPC в заголовке ответа установлен в превышен срок ожидания * resource-exhausted: Loadbalancer повторит попытку, если код состояния gRPC в заголовке ответа установлен в исчерпаны ресурсы * unavailable: Loadbalancer повторит попытку, если код состояния gRPC в заголовке ответа установлен в недоступен. | |||||||
| timeout complex | success | Указывает таймаут для выбранного маршрута. Таймаут вычисляется с момента полного обработки запроса (т.е. конца потока) до момента полной обработки ответа. Таймаут включает все повторные попытки. Если не указано, значение по умолчанию составляет 15 секунд. | |||||||
| nanos integer | success | Промежуток времени, который является дробной частью секунды с разрешением в наносекунды. Продолжительности менее одной секунды представлены значением поля `seconds`, равным 0, и положительным значением поля `nanos`. Должно быть в диапазоне от 0 до 999 999 999 включительно. | |||||||
| seconds string | success | Промежуток времени с разрешением в секунды. Должно быть в диапазоне от 0 до 315 576 000 000 включительно. | |||||||
| urlRewrite complex | success | Спецификация для изменения URL запроса перед переадресацией запроса на сопоставленную службу. | |||||||
| hostRewrite string | success | Перед переадресацией запроса на выбранную службу заголовок хоста запроса заменяется содержимым hostRewrite. Значение должно быть в диапазоне от 1 до 255 символов. | |||||||
| pathPrefixRewrite string | success | Перед переадресацией запроса на выбранную бэкенд-службу соответствующая часть пути запроса заменяется на pathPrefixRewrite. Значение должно быть в диапазоне от 1 до 1024 символов. | |||||||
| weightedBackendServices complex | success | Список взвешенных бэкенд-служб, которым будет отправляться трафик при совпадении маршрута. Веса определяют долю трафика, которая направляется в соответствующую бэкенд-службу. Если весь трафик должен направляться в одну бэкенд-службу, должно быть одно weightedBackendService со значением веса отличным от 0. После определения backendService и перед пересылкой запроса на бэкенд-службу применяются дополнительные действия маршрутизации, такие как переписывание URL и преобразование заголовков, в зависимости от дополнительных параметров, указанных в HttpRouteAction. | |||||||
| backendService dictionary | success | Ресурс RegionBackendService по умолчанию. Перед пересылкой запроса на backendService, балансировщик приложений применяет все соответствующие headerActions, указанные в рамках этого backendServiceWeight. | |||||||
| headerAction complex | success | Указывает изменения в заголовках запросов и ответов, которые необходимо применить для выбранной backendService. headerAction, указанные здесь, применяются перед headerAction в охватывающем HttpRouteRule, PathMatcher и UrlMap. | |||||||
| requestHeadersToAdd complex | success | Заголовки, которые необходимо добавить к соответствующему запросу перед переадресацией запроса на backendService. | |||||||
| headerName string | success | Название заголовка. | |||||||
| headerValue string | success | Значение добавляемого заголовка. | |||||||
| replace boolean | success | Если false, headerValue добавляется к существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, отбрасывая предыдущие значения. | |||||||
| requestHeadersToRemove list / elements=string | success | Список имён заголовков, которые нужно удалить из запроса перед отправкой в backendService. | |||||||
| responseHeadersToAdd complex | success | Заголовки, которые нужно добавить в ответ перед отправкой клиенту. | |||||||
| headerName string | success | Имя заголовка. | |||||||
| headerValue string | success | Значение добавляемого заголовка. | |||||||
| replace boolean | success | Если false, headerValue добавляется к существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, отбрасывая предыдущие значения. | |||||||
| responseHeadersToRemove list / elements=string | success | Список имён заголовков, которые нужно удалить из ответа перед отправкой клиенту. | |||||||
| weight integer | success | Определяет долю трафика, направляемого в backendService, вычисляется как weight / (сумма весов всех weightedBackendService в routeAction). Выбор backend service определяется только для нового трафика. После направления запроса пользователя в backendService последующие запросы будут направлены в тот же backendService, как определено политикой affinity backendService. Значение должно быть между 0 и 1000. | |||||||
| service dictionary | success | Ресурс backend service в регионе, в который будет направлен трафик, если правило совпадет. Если дополнительно указан routeAction, выполняются продвинутые действия маршрутизации, такие как URL Rewrites и т.д., прежде чем запрос будет отправлен в backend. Однако, если указан service, routeAction не может содержать weightedBackendService. И наоборот, если routeAction содержит weightedBackendServices, service не должен быть указан. Должно быть указано только одно из urlRedirect, service или routeAction.weightedBackendService. | |||||||
| urlRedirect complex | success | При совпадении этого правила запрос перенаправляется на URL, указанный в urlRedirect. Если указан urlRedirect, service или routeAction не должны быть указаны. | |||||||
| hostRedirect string | success | Хост, который будет использован в ответе перенаправления вместо хоста, предоставленного в запросе. Значение должно быть от 1 до 255 символов. | |||||||
| httpsRedirect boolean | success | Если установлено в true, схема URL в перенаправленном запросе устанавливается в https. Если установлено в false, схема URL перенаправленного запроса останется такой же, как в запросе. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка этого в true для TargetHttpsProxy запрещена. По умолчанию установлено в false. | |||||||
| pathRedirect string | success | Путь, который будет использован в ответе перенаправления вместо пути, предоставленного в запросе. pathRedirect не может быть указан вместе с prefixRedirect. Укажите один или ни одного. Если ни один не указан, путь исходного запроса будет использован для перенаправления. Значение должно быть от 1 до 1024 символов. | |||||||
| prefixRedirect string | success | Префикс, который заменяет префиксMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL перед перенаправлением запроса. prefixRedirect не может быть указан вместе с pathRedirect. Укажите один или ни одного. Если ни один не указан, путь исходного запроса будет использован для перенаправления. Значение должно быть от 1 до 1024 символов. | |||||||
| redirectResponseCode string | success | Код HTTP-статуса для этого RedirectAction. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT, по умолчанию, соответствует 301. * FOUND, соответствует 302. * SEE_OTHER, соответствует 303. * TEMPORARY_REDIRECT, соответствует 307. В этом случае метод запроса сохранится. * PERMANENT_REDIRECT, соответствует 308. В этом случае метод запроса сохранится. | |||||||
| stripQuery boolean | success | Если установлено в true, любая часть запроса в исходном URL удаляется перед перенаправлением. Если false, часть запроса сохраняется. По умолчанию false. | |||||||
| region string | success | Ссылка на регион, в котором находится url map. | |||||||
| tests complex | success | Список ожидаемых сопоставлений URL. Запросы на обновление UrlMap будут успешны только если пройдут все тестовые случаи. | |||||||
| description string | success | Описание тестового случая. | |||||||
| host string | success | Часть хоста URL. | |||||||
| path string | success | Часть пути URL. | |||||||
| service dictionary | success | Ссылка на ожидаемый RegionBackendService ресурс, к которому должен быть сопоставлен данный URL. | |||||||
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_region_url_map_info_module.html