update-gateway-route
Описание
Обновляет существующий шлюзовой маршрут, связанный с указанным виртуальным шлюзом в сервисной сетке.
См. также: Документацию API AWS
Синтаксис
update-gateway-route
[--client-token <value>]
--gateway-route-name <value>
--mesh-name <value>
[--mesh-owner <value>]
--spec <value>
--virtual-gateway-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--client-token (строка)
--gateway-route-name (строка)
--mesh-name (строка)
--mesh-owner (строка)
--spec (структура)
Новая спецификация шлюзового маршрута для применения. Она перезаписывает существующие данные.
grpcRoute -> (структура)
Объект, представляющий собой спецификацию gRPC шлюзового маршрута.
action -> (структура)
Объект, представляющий собой действие, которое выполняется, если совпадение определено.
rewrite -> (структура)
Действие шлюзового маршрута для переписывания.
hostname -> (структура)
Имя хоста шлюзового маршрута для переписывания.
defaultTargetHostname -> (строка)
target -> (структура)
Объект, представляющий собой целевой ресурс, к которому маршрутизируется трафик, когда запрос соответствует шлюзовому маршруту.
port -> (целое число)
virtualService -> (структура)
Объект, представляющий собой целевой ресурс виртуальной службы шлюзового маршрута.
virtualServiceName -> (строка)
match -> (структура)
Объект, представляющий критерии для определения соответствия запроса.
hostname -> (структура)
Имя хоста шлюзового маршрута, по которому необходимо выполнить соответствие.
exact -> (строка)
suffix -> (строка)
metadata -> (список)
Метаданные шлюзового маршрута для сопоставления.
(структура)
Объект, представляющий метаданные шлюзового маршрута.
invert -> (булево)
True для сопоставления с любым значением, кроме критериев соответствия. Значение по умолчанию - False.match -> (структура помеченного союза)
Критерии для определения соответствия метаданных.
Примечание
Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть установлен:exact, prefix, range, regex, suffix.exact -> (строка)
prefix -> (строка)
range -> (структура)
Объект, представляющий собой диапазон значений для сопоставления. Первый символ диапазона включен в диапазон, хотя последний не включён. Например, если указан диапазон 1-100, будут сопоставляться только значения 1-99.
end -> (длинное целое число)
start -> (длинное целое число)
regex -> (строка)
suffix -> (строка)
name -> (строка)
port -> (целое число)
serviceName -> (строка)
http2Route -> (структура)
Объект, представляющий собой спецификацию HTTP/2 шлюзового маршрута.
action -> (структура)
Объект, представляющий собой действие, которое выполняется, если совпадение определено.
rewrite -> (структура)
Действие шлюзового маршрута для переписывания.
hostname -> (структура)
Имя хоста для переписывания.
defaultTargetHostname -> (строка)
path -> (структура)
Путь для переписывания.
exact -> (строка)
prefix -> (структура)
Указанные начальные символы для переписывания.
defaultPrefix -> (строка)
value -> (строка)
target -> (структура)
Объект, представляющий собой целевой ресурс, к которому маршрутизируется трафик, когда запрос соответствует шлюзовому маршруту.
port -> (целое число)
virtualService -> (структура)
Объект, представляющий собой целевой ресурс виртуальной службы шлюзового маршрута.
virtualServiceName -> (строка)
match -> (структура)
Объект, представляющий критерии для определения соответствия запроса.
headers -> (список)
Заголовки клиентского запроса для сопоставления.
(структура)
Объект, представляющий собой заголовок HTTP в шлюзовом маршруте.
invert -> (булево)
True для сопоставления с любым значением, кроме критериев соответствия. Значение по умолчанию - False.match -> (структура помеченного союза)
Объект, представляющий метод и значение для сопоставления со значением заголовка, отправленным в запросе. Укажите один метод сопоставления.
Примечание
Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть установлен:exact, prefix, range, regex, suffix.exact -> (строка)
prefix -> (строка)
range -> (структура)
Объект, представляющий собой диапазон значений для сопоставления.
end -> (длинное целое число)
start -> (длинное целое число)
regex -> (строка)
suffix -> (строка)
name -> (строка)
hostname -> (структура)
Имя хоста для сопоставления.
exact -> (строка)
suffix -> (строка)
method -> (строка)
path -> (структура)
Путь для сопоставления.
exact -> (строка)
regex -> (строка)
port -> (целое число)
prefix -> (строка)
/, который сам по себе соответствует всем запросам к имени виртуальной службы. Вы также можете сопоставить запросы на основе путей. Например, если имя вашей виртуальной службы - my-service.local, и вы хотите, чтобы маршрут соответствовал запросам к my-service.local/metrics, ваш префикс должен быть /metrics.queryParameters -> (список)
Параметр запроса для сопоставления.
(структура)
Объект, представляющий параметр запроса в запросе.
match -> (структура)
Параметр запроса для сопоставления.
exact -> (строка)
name -> (строка)
httpRoute -> (структура)
Объект, представляющий спецификацию маршрута шлюза HTTP.
action -> (структура)
Объект, представляющий действие, которое необходимо выполнить при совпадении с маршрутом.
rewrite -> (структура)
Действие маршрута шлюза для переписывания.
hostname -> (структура)
Имя хоста для переписывания.
defaultTargetHostname -> (строка)
path -> (структура)
Путь для переписывания.
exact -> (строка)
prefix -> (структура)
Указанные начальные символы для переписывания.
defaultPrefix -> (строка)
value -> (строка)
target -> (структура)
Объект, представляющий целевой ресурс, на который перенаправляется трафик при совпадении запроса с маршрутом шлюза.
port -> (целое число)
virtualService -> (структура)
Объект, представляющий целевой ресурс маршрута шлюза — виртуальную службу.
virtualServiceName -> (строка)
match -> (структура)
Объект, представляющий критерии для определения совпадения запроса.
headers -> (список)
Заголовки запроса клиента, по которым выполняется сопоставление.
(структура)
Объект, представляющий HTTP-заголовок в маршруте шлюза.
invert -> (булево)
True для соответствия всем значениям, кроме заданных критериев. Значение по умолчанию — False.match -> (меченый союз структур)
Объект, представляющий метод и значение для сопоставления со значением заголовка, отправленного в запросе. Укажите один метод сопоставления.
Примечание
Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан:exact, prefix, range, regex, suffix.exact -> (строка)
prefix -> (строка)
range -> (структура)
Объект, представляющий диапазон значений для сопоставления.
end -> (длинное целое число)
start -> (длинное целое число)
regex -> (строка)
suffix -> (строка)
name -> (строка)
hostname -> (структура)
Имя хоста для сопоставления.
exact -> (строка)
suffix -> (строка)
method -> (строка)
path -> (структура)
Путь для сопоставления.
exact -> (строка)
regex -> (строка)
port -> (целое число)
prefix -> (строка)
/ , что само по себе соответствует всем запросам к имени виртуальной службы. Вы также можете использовать сопоставление для маршрутизации запросов по пути. Например, если имя вашей виртуальной службы — my-service.local, а вы хотите, чтобы маршрут соответствовал запросам на my-service.local/metrics, ваш префикс должен быть /metrics.queryParameters -> (список)
Параметр запроса для сопоставления.
(структура)
Объект, представляющий параметр запроса в запросе.
match -> (структура)
Параметр запроса для сопоставления.
exact -> (строка)
name -> (строка)
priority -> (целое число)
Синтаксис JSON:
{
"grpcRoute": {
"action": {
"rewrite": {
"hostname": {
"defaultTargetHostname": "ENABLED"|"DISABLED"
}
},
"target": {
"port": integer,
"virtualService": {
"virtualServiceName": "string"
}
}
},
"match": {
"hostname": {
"exact": "string",
"suffix": "string"
},
"metadata": [
{
"invert": true|false,
"match": {
"exact": "string",
"prefix": "string",
"range": {
"end": long,
"start": long
},
"regex": "string",
"suffix": "string"
},
"name": "string"
}
...
],
"port": integer,
"serviceName": "string"
}
},
"http2Route": {
"action": {
"rewrite": {
"hostname": {
"defaultTargetHostname": "ENABLED"|"DISABLED"
},
"path": {
"exact": "string"
},
"prefix": {
"defaultPrefix": "ENABLED"|"DISABLED",
"value": "string"
}
},
"target": {
"port": integer,
"virtualService": {
"virtualServiceName": "string"
}
}
},
"match": {
"headers": [
{
"invert": true|false,
"match": {
"exact": "string",
"prefix": "string",
"range": {
"end": long,
"start": long
},
"regex": "string",
"suffix": "string"
},
"name": "string"
}
...
],
"hostname": {
"exact": "string",
"suffix": "string"
},
"method": "GET"|"HEAD"|"POST"|"PUT"|"DELETE"|"CONNECT"|"OPTIONS"|"TRACE"|"PATCH",
"path": {
"exact": "string",
"regex": "string"
},
"port": integer,
"prefix": "string",
"queryParameters": [
{
"match": {
"exact": "string"
},
"name": "string"
}
...
]
}
},
"httpRoute": {
"action": {
"rewrite": {
"hostname": {
"defaultTargetHostname": "ENABLED"|"DISABLED"
},
"path": {
"exact": "string"
},
"prefix": {
"defaultPrefix": "ENABLED"|"DISABLED",
"value": "string"
}
},
"target": {
"port": integer,
"virtualService": {
"virtualServiceName": "string"
}
}
},
"match": {
"headers": [
{
"invert": true|false,
"match": {
"exact": "string",
"prefix": "string",
"range": {
"end": long,
"start": long
},
"regex": "string",
"suffix": "string"
},
"name": "string"
}
...
],
"hostname": {
"exact": "string",
"suffix": "string"
},
"method": "GET"|"HEAD"|"POST"|"PUT"|"DELETE"|"CONNECT"|"OPTIONS"|"TRACE"|"PATCH",
"path": {
"exact": "string",
"regex": "string"
},
"port": integer,
"prefix": "string",
"queryParameters": [
{
"match": {
"exact": "string"
},
"name": "string"
}
...
]
}
},
"priority": integer
}
--virtual-gateway-name (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные данные с помощью значения, предоставленного JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, выполняет проверку входных данных команд и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Общие параметры
--debug (булево)
Включить отладочную запись в журнал.
--endpoint-url (строка)
Переопределить значение URL по умолчанию команды на указанный URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.
--no-paginate (булево)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включено
- выключено
- автоматически
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с пакетом сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использоваться содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного значения cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключить страницу CLI для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров ввода CLI.
Вывод
gatewayRoute -> (структура)
Полное описание обновленного шлюзового маршрута.
gatewayRouteName -> (строка)
meshName -> (строка)
metadata -> (структура)
Объект, представляющий метаданные ресурса.
arn -> (строка)
createdAt -> (временная метка)
lastUpdatedAt -> (временная метка)
meshOwner -> (строка)
resourceOwner -> (строка)
uid -> (строка)
version -> (длинное целое число)
spec -> (структура)
Спецификации шлюзового маршрута.
grpcRoute -> (структура)
Объект, представляющий спецификацию маршрута gRPC шлюза.
action -> (структура)
Объект, представляющий действие, которое выполняется при определении совпадения.
rewrite -> (структура)
Действие шлюзового маршрута для переписывания.
hostname -> (структура)
Имя хоста шлюзового маршрута для переписывания.
defaultTargetHostname -> (строка)
target -> (структура)
Объект, представляющий целевой адрес, к которому направляется трафик при совпадении запроса со шлюзовым маршрутом.
port -> (целое число)
virtualService -> (структура)
Объект, представляющий целевой адрес маршрута шлюза виртуальной службы.
virtualServiceName -> (строка)
match -> (структура)
Объект, представляющий критерии для определения совпадения запроса.
hostname -> (структура)
Имя хоста шлюзового маршрута, по которому будет выполняться сопоставление.
exact -> (строка)
suffix -> (строка)
metadata -> (список)
Метаданные шлюзового маршрута, по которым будет выполняться сопоставление.
(структура)
Объект, представляющий метаданные шлюзового маршрута.
invert -> (булево)
True, чтобы сопоставить всё, кроме критериев совпадения. Значение по умолчанию - False.match -> (структура помеченного объединения)
Критерии для определения соответствия метаданных.
Примечание
Это структура помеченного объединения. Может быть задан только один из следующих ключей верхнего уровня:exact, prefix, range, regex, suffix.exact -> (строка)
prefix -> (строка)
range -> (структура)
Объект, представляющий диапазон значений для сопоставления. Первый символ диапазона включается в диапазон, но последний не включается. Например, если указан диапазон 1-100, будут сопоставляться только значения 1-99.
end -> (длинное целое число)
start -> (длинное целое число)
regex -> (строка)
suffix -> (строка)
name -> (строка)
port -> (целое число)
serviceName -> (строка)
http2Route -> (структура)
Объект, представляющий спецификацию маршрута HTTP/2 шлюза.
action -> (структура)
Объект, представляющий действие, которое выполняется при определении совпадения.
rewrite -> (структура)
Действие шлюзового маршрута для переписывания.
hostname -> (структура)
Имя хоста для переписывания.
defaultTargetHostname -> (строка)
path -> (структура)
Путь для переписывания.
exact -> (строка)
prefix -> (структура)
Указанные начальные символы для переписывания.
defaultPrefix -> (строка)
value -> (строка)
target -> (структура)
Объект, представляющий целевой адрес, к которому направляется трафик при совпадении запроса со шлюзовым маршрутом.
port -> (целое число)
virtualService -> (структура)
Объект, представляющий целевой адрес маршрута шлюза виртуальной службы.
virtualServiceName -> (строка)
match -> (структура)
Объект, представляющий критерии для определения совпадения запроса.
headers -> (список)
Заголовки входящего запроса для сопоставления.
(структура)
Объект, представляющий HTTP-заголовок в маршруте шлюза.
invert -> (булево)
True, чтобы сопоставить всё, кроме критериев совпадения. Значение по умолчанию - False.match -> (структура помеченного объединения)
Объект, представляющий метод и значение для сопоставления со значением заголовка, отправленным в запросе. Укажите один метод сопоставления.
Примечание
Это структура помеченного объединения. Может быть задан только один из следующих ключей верхнего уровня:exact, prefix, range, regex, suffix.exact -> (строка)
prefix -> (строка)
range -> (структура)
Объект, представляющий диапазон значений для сопоставления.
end -> (длинное целое число)
start -> (длинное целое число)
regex -> (строка)
suffix -> (строка)
name -> (строка)
hostname -> (структура)
Имя хоста для сопоставления.
exact -> (строка)
suffix -> (строка)
method -> (строка)
path -> (структура)
Путь для сопоставления.
exact -> (строка)
regex -> (строка)
port -> (целое число)
prefix -> (строка)
/, что само по себе соответствует всем запросам к имени виртуальной службы. Также можно сопоставить запросы для маршрутизации по пути. Например, если имя вашей виртуальной службы - my-service.local, и вы хотите, чтобы маршрут соответствовал запросам на my-service.local/metrics, ваш префикс должен быть /metrics.queryParameters -> (список)
Параметр запроса для сопоставления.
(структура)
Объект, представляющий параметр запроса в запросе.
match -> (структура)
Параметр запроса для сопоставления.
exact -> (строка)
name -> (строка)
httpRoute -> (структура)
Объект, представляющий спецификацию маршрута шлюза HTTP.
action -> (структура)
Объект, представляющий действие, которое должно быть выполнено при совпадении.
rewrite -> (структура)
Действие маршрута шлюза для переписывания.
hostname -> (структура)
Имя хоста для переписывания.
defaultTargetHostname -> (строка)
path -> (структура)
Путь для переписывания.
exact -> (строка)
prefix -> (структура)
Указанные начальные символы для переписывания.
defaultPrefix -> (строка)
value -> (строка)
target -> (структура)
Объект, представляющий целевой ресурс, на который перенаправляется трафик при совпадении запроса с маршрутом шлюза.
port -> (целое число)
virtualService -> (структура)
Объект, представляющий целевой ресурс маршрута шлюза — виртуальную службу.
virtualServiceName -> (строка)
match -> (структура)
Объект, представляющий критерии для определения совпадения запроса.
headers -> (список)
Заголовки запроса клиента для сопоставления.
(структура)
Объект, представляющий HTTP-заголовок в маршруте шлюза.
invert -> (булево)
True, чтобы сопоставлять всё, кроме критериев сопоставления. Значение по умолчанию — False.match -> (меченый объединённый тип данных)
Объект, представляющий метод и значение для сопоставления со значением заголовка, отправленного в запросе. Укажите один метод сопоставления.
Примечание
Это структура меченого объединённого типа данных. Можно установить только один из следующих верхних ключей:exact, prefix, range, regex, suffix.exact -> (строка)
prefix -> (строка)
range -> (структура)
Объект, представляющий диапазон значений для сопоставления.
end -> (длинное целое число)
start -> (длинное целое число)
regex -> (строка)
suffix -> (строка)
name -> (строка)
hostname -> (структура)
Имя хоста для сопоставления.
exact -> (строка)
suffix -> (строка)
method -> (строка)
path -> (структура)
Путь для сопоставления.
exact -> (строка)
regex -> (строка)
port -> (целое число)
prefix -> (строка)
/, что само по себе соответствует всем запросам к имени виртуальной службы. Также можно сопоставлять запросы для маршрутизации по пути. Например, если имя вашей виртуальной службы — my-service.local, и вы хотите, чтобы маршрут сопоставлял запросы к my-service.local/metrics, ваш префикс должен быть /metrics.queryParameters -> (список)
Параметр запроса для сопоставления.
(структура)
Объект, представляющий параметр запроса в запросе.
match -> (структура)
Параметр запроса для сопоставления.
exact -> (строка)
name -> (строка)
priority -> (целое число)
status -> (структура)
Статус маршрута шлюза.
status -> (строка)
virtualGatewayName -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.