update-route

Описание

Обновляет существующий маршрут для указанной сети сервисов и виртуального маршрутизатора.

См. также: Документацию API AWS

Синтаксис

  update-route
[--client-token <value>]
--mesh-name <value>
[--mesh-owner <value>]
--route-name <value>
--spec <value>
--virtual-router-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 (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Допускается до 36 букв, цифр, дефисов и подчеркиваний.

--mesh-name (строка)

Имя сети сервисов, в которой находится маршрут.

--mesh-owner (строка)

Идентификатор учетной записи AWS IAM Amazon Web Services владельца сети сервисов. Если идентификатор учетной записи не ваш, это идентификатор учетной записи, которая поделилась сеткой с вашей учетной записью. Дополнительную информацию о совместном использовании сетей см. в разделе Работа с совместно используемыми сетями.

--route-name (строка)

Имя маршрута для обновления.

--spec (структура)

Новое описание маршрута для применения. Это перезаписывает существующие данные.

grpcRoute -> (структура)

Объект, представляющий описание маршрута gRPC.

action -> (структура)

Объект, представляющий действие, которое должно быть выполнено при совпадении запроса с шаблоном.

weightedTargets -> (список)

Объект, представляющий целевые узлы, куда будет направлен трафик при совпадении запроса с маршрутом.

(структура)

Объект, представляющий целевой узел и его относительный вес. Трафик распределяется между целевыми узлами пропорционально их весу. Например, целевой узел с весом 50 получит в пять раз больше трафика, чем узел с весом 10. Общий вес всех целевых узлов должен быть не больше 100.

port -> (целое число)

Целевой порт объекта с весом.

virtualNode -> (строка)

Виртуальный узел, ассоциированный с целевым узлом.

weight -> (целое число)

Относительный вес целевого узла.

match -> (структура)

Объект, представляющий критерии для определения совпадения запроса с маршрутом.

metadata -> (список)

Объект, представляющий данные для сопоставления из запроса.

(структура)

Объект, представляющий метаданные соответствия для маршрута.

invert -> (булево)

Укажите True, чтобы сопоставлять всё, кроме критериев соответствия. Значение по умолчанию - False.

match -> (структура помеченных союзов)

Объект, представляющий данные для сопоставления из запроса.

Примечание

Это структура помеченных союзов. Только один из следующих ключей верхнего уровня может быть задан: exact, prefix, range, regex, suffix.

exact -> (строка)

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

prefix -> (строка)

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

range -> (структура)

Объект, представляющий диапазон значений для сопоставления.

end -> (длинное целое число)

Конец диапазона.

start -> (длинное целое число)

Начало диапазона.

regex -> (строка)

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

suffix -> (строка)

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

name -> (строка)

Название маршрута.

methodName -> (строка)

Имя метода для сопоставления из запроса. Если вы указываете имя, вы также должны указать serviceName.

port -> (целое число)

Номер порта для сопоставления.

serviceName -> (строка)

Полное доменное имя сервиса для сопоставления из запроса.

retryPolicy -> (структура)

Объект, представляющий политику повторных попыток.

grpcRetryEvents -> (список)

Укажите, по крайней мере, одно из допустимых значений.

(строка)

httpRetryEvents -> (список)

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

server-error – HTTP-статусы 500, 501, 502, 503, 504, 505, 506, 507, 508, 510 и 511
gateway-error – HTTP-статусы 502, 503 и 504
client-error – HTTP-статус 409
stream-error – Повторная попытка при отказе от потока

(строка)

maxRetries -> (длинное целое число)

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

perRetryTimeout -> (структура)

Таймаут для каждой попытки повтора.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

tcpRetryEvents -> (список)

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

(строка)

timeout -> (структура)

Объект, представляющий типы таймаутов.

idle -> (структура)

Объект, представляющий таймаут бездействия. Таймаут бездействия ограничивает время, в течение которого соединение может быть бездействующим. Значение по умолчанию — none.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

perRequest -> (структура)

Объект, представляющий таймаут для каждого запроса. Значение по умолчанию — 15 секунд. Если вы устанавливаете более длительный таймаут, убедитесь, что это значение установлено для каждого ресурса App Mesh в диалоге. Например, если виртуальный узел бэкенда использует виртуальный маршрутизатор для перенаправления на другой виртуальный узел, таймаут должен быть больше 15 секунд для исходного и целевого виртуальных узлов и маршрута.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

http2Route -> (структура)

Объект, представляющий описание маршрута HTTP/2.

action -> (структура)

Объект, представляющий действие, которое должно быть выполнено при совпадении запроса с шаблоном.

weightedTargets -> (список)

Объект, представляющий целевые узлы, куда будет направлен трафик при совпадении запроса с маршрутом.

(структура)

port -> (целое число)

Целевой порт объекта с весом.

virtualNode -> (строка)

Виртуальный узел, ассоциированный с целевым узлом.

weight -> (целое число)

Относительный вес целевого узла.

match -> (структура)

Объект, представляющий критерии для определения совпадения запроса с маршрутом.

headers -> (список)

Заголовки запроса клиента для сопоставления.

(структура)

Объект, представляющий HTTP-заголовок в запросе.

invert -> (булево)

Укажите True, чтобы сопоставлять всё, кроме критериев соответствия. Значение по умолчанию - False.

match -> (структура помеченных союзов)

Объект HeaderMatchMethod.

Примечание

exact -> (строка)

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

prefix -> (строка)

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

range -> (структура)

Объект, представляющий диапазон значений для сопоставления.

end -> (длинное целое число)

Конец диапазона.

start -> (длинное целое число)

Начало диапазона.

regex -> (строка)

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

suffix -> (строка)

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

name -> (строка)

Имя HTTP-заголовка в запросе клиента, на котором будет производиться сопоставление.

method -> (строка)

Метод запроса клиента для сопоставления. Укажите только один.

path -> (структура)

Путь запроса клиента для сопоставления.

exact -> (строка)

Точный путь для сопоставления.

regex -> (строка)

Регулярное выражение для сопоставления пути.

port -> (целое число)

Номер порта для сопоставления.

prefix -> (строка)

Указывает путь для сопоставления запросов. Этот параметр всегда должен начинаться с /, что само по себе сопоставляет все запросы к имени виртуальной службы. Также можно сопоставлять запросы на основе путей. Например, если ваше имя виртуальной службы - my-service.local, а вы хотите, чтобы маршрут сопоставлял запросы на my-service.local/metrics, ваш префикс должен быть /metrics.

queryParameters -> (список)

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

(структура)

Объект, представляющий параметр запроса в запросе.

match -> (структура)

Параметр запроса для сопоставления.

exact -> (строка)

Точный параметр запроса для сопоставления.

name -> (строка)

Имя параметра запроса, на котором будет проводиться сопоставление.

scheme -> (строка)

Схема запроса клиента для сопоставления. Укажите только один. Применимо только к маршрутам HTTP2.

retryPolicy -> (структура)

Объект, представляющий политику повторных попыток.

httpRetryEvents -> (список)

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

server-error – HTTP-статусы 500, 501, 502, 503, 504, 505, 506, 507, 508, 510 и 511
gateway-error – HTTP-статусы 502, 503 и 504
client-error – HTTP-статус 409
stream-error – Повторная попытка при отказе от потока

(строка)

maxRetries -> (длинное целое число)

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

perRetryTimeout -> (структура)

Таймаут для каждой попытки повтора.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

tcpRetryEvents -> (список)

(строка)

timeout -> (структура)

Объект, представляющий типы таймаутов.

idle -> (структура)

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

perRequest -> (структура)

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

httpRoute -> (структура)

Объект, представляющий спецификацию HTTP-маршрута.

action -> (структура)

Объект, представляющий действие, которое должно быть выполнено при совпадении с маршрутом.

weightedTargets -> (список)

Объект, представляющий целевые адреса, на которые будет перенаправлен трафик при совпадении запроса с маршрутом.

(структура)

Объект, представляющий целевой адрес и его относительный вес. Трафик распределяется между целевыми адресами в соответствии с их относительным весом. Например, целевой адрес с относительным весом 50 получает в пять раз больше трафика, чем целевой адрес с относительным весом 10. Общий вес всех целевых адресов должен быть меньше или равен 100.

port -> (целое число)

Целевой порт объекта с весом.

virtualNode -> (строка)

Виртуальный узел, который необходимо связать с целевым адресом с весом.

weight -> (целое число)

Относительный вес целевого адреса с весом.

match -> (структура)

Объект, представляющий критерии для определения совпадения с запросом.

headers -> (список)

Заголовки клиентского запроса для сопоставления.

(структура)

Объект, представляющий HTTP-заголовок в запросе.

invert -> (булево)

Укажите True для сопоставления со всем, кроме критериев сопоставления. Значение по умолчанию — False.

match -> (меченый союз структур)

Объект HeaderMatchMethod.

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть задан: exact, prefix, range, regex, suffix.

exact -> (строка)

Переданное клиентом значение должно точно совпадать с указанным значением.

prefix -> (строка)

Переданное клиентом значение должно начинаться с указанных символов.

range -> (структура)

Объект, представляющий диапазон значений для сопоставления.

end -> (длинное целое число)

Конец диапазона.

start -> (длинное целое число)

Начало диапазона.

regex -> (строка)

Переданное клиентом значение должно содержать указанные символы.

suffix -> (строка)

Переданное клиентом значение должно заканчиваться указанными символами.

name -> (строка)

Имя HTTP-заголовка в клиентском запросе, на котором будет производиться сопоставление.

method -> (строка)

Метод клиентского запроса для сопоставления. Указать только один.

path -> (структура)

Путь клиентского запроса для сопоставления.

exact -> (строка)

Точный путь для сопоставления.

regex -> (строка)

Регулярное выражение, используемое для сопоставления пути.

port -> (целое число)

Номер порта для сопоставления.

prefix -> (строка)

Указывает путь для сопоставления запросов. Этот параметр всегда должен начинаться с /, который сам по себе сопоставляет все запросы виртуальному имени службы. Также можно сопоставлять запросы по пути. Например, если имя вашей виртуальной службы — my-service.local, и вы хотите, чтобы маршрут сопоставлялся с запросами на my-service.local/metrics, ваш префикс должен быть /metrics.

queryParameters -> (список)

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

(структура)

Объект, представляющий параметр запроса в запросе.

match -> (структура)

Параметр запроса для сопоставления.

exact -> (строка)

Точный параметр запроса для сопоставления.

name -> (строка)

Имя параметра запроса, на котором будет производиться сопоставление.

scheme -> (строка)

Схема клиентского запроса для сопоставления. Указать только одну. Применимо только для маршрутов HTTP2.

retryPolicy -> (структура)

Объект, представляющий политику повторных попыток.

httpRetryEvents -> (список)

Укажите хотя бы одно из следующих значений.

server-error – HTTP-коды состояния 500, 501, 502, 503, 504, 505, 506, 507, 508, 510 и 511
gateway-error – HTTP-коды состояния 502, 503 и 504
client-error – HTTP-код состояния 409
stream-error – Повторная попытка при отказе от потока

(строка)

maxRetries -> (длинное целое число)

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

perRetryTimeout -> (структура)

Таймаут для каждой попытки повтора.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Количество единиц измерения времени.

tcpRetryEvents -> (список)

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

(строка)

timeout -> (структура)

Объект, представляющий типы таймаутов.

idle -> (структура)

Объект, представляющий таймаут бездействия. Таймаут бездействия ограничивает время простоя соединения. Значение по умолчанию — none.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Количество единиц измерения времени.

perRequest -> (структура)

Объект, представляющий таймаут для каждого запроса. Значение по умолчанию — 15 секунд. Если вы устанавливаете более высокий таймаут, убедитесь, что это значение установлено для каждого ресурса App Mesh в диалоге. Например, если виртуальный узел бэкенда использует виртуальный маршрутизатор для перенаправления на другой виртуальный узел, таймаут должен быть больше 15 секунд для исходного и целевого виртуальных узлов и маршрута.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Количество единиц измерения времени.

priority -> (целое число)

Приоритет маршрута. Маршруты сопоставляются на основе указанного значения, где 0 — наивысший приоритет.

tcpRoute -> (структура)

Объект, представляющий спецификацию TCP-маршрута.

action -> (структура)

Действие, которое должно быть выполнено при совпадении с маршрутом.

weightedTargets -> (список)

(структура)

port -> (целое число)

Целевой порт объекта с весом.

virtualNode -> (строка)

Виртуальный узел, который необходимо связать с целевым адресом с весом.

weight -> (целое число)

Относительный вес целевого адреса с весом.

match -> (структура)

Объект, представляющий критерии для определения совпадения с запросом.

port -> (целое число)

Номер порта для сопоставления.

timeout -> (структура)

Объект, представляющий типы таймаутов.

idle -> (структура)

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Количество единиц измерения времени.

Синтаксис JSON:

{
  "grpcRoute": {
    "action": {
      "weightedTargets": [
        {
          "port": integer,
          "virtualNode": "string",
          "weight": integer
        }
        ...
      ]
    },
    "match": {
      "metadata": [
        {
          "invert": true|false,
          "match": {
            "exact": "string",
            "prefix": "string",
            "range": {
              "end": long,
              "start": long
            },
            "regex": "string",
            "suffix": "string"
          },
          "name": "string"
        }
        ...
      ],
      "methodName": "string",
      "port": integer,
      "serviceName": "string"
    },
    "retryPolicy": {
      "grpcRetryEvents": ["cancelled"|"deadline-exceeded"|"internal"|"resource-exhausted"|"unavailable", ...],
      "httpRetryEvents": ["string", ...],
      "maxRetries": long,
      "perRetryTimeout": {
        "unit": "s"|"ms",
        "value": long
      },
      "tcpRetryEvents": ["connection-error", ...]
    },
    "timeout": {
      "idle": {
        "unit": "s"|"ms",
        "value": long
      },
      "perRequest": {
        "unit": "s"|"ms",
        "value": long
      }
    }
  },
  "http2Route": {
    "action": {
      "weightedTargets": [
        {
          "port": integer,
          "virtualNode": "string",
          "weight": integer
        }
        ...
      ]
    },
    "match": {
      "headers": [
        {
          "invert": true|false,
          "match": {
            "exact": "string",
            "prefix": "string",
            "range": {
              "end": long,
              "start": long
            },
            "regex": "string",
            "suffix": "string"
          },
          "name": "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"
        }
        ...
      ],
      "scheme": "http"|"https"
    },
    "retryPolicy": {
      "httpRetryEvents": ["string", ...],
      "maxRetries": long,
      "perRetryTimeout": {
        "unit": "s"|"ms",
        "value": long
      },
      "tcpRetryEvents": ["connection-error", ...]
    },
    "timeout": {
      "idle": {
        "unit": "s"|"ms",
        "value": long
      },
      "perRequest": {
        "unit": "s"|"ms",
        "value": long
      }
    }
  },
  "httpRoute": {
    "action": {
      "weightedTargets": [
        {
          "port": integer,
          "virtualNode": "string",
          "weight": integer
        }
        ...
      ]
    },
    "match": {
      "headers": [
        {
          "invert": true|false,
          "match": {
            "exact": "string",
            "prefix": "string",
            "range": {
              "end": long,
              "start": long
            },
            "regex": "string",
            "suffix": "string"
          },
          "name": "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"
        }
        ...
      ],
      "scheme": "http"|"https"
    },
    "retryPolicy": {
      "httpRetryEvents": ["string", ...],
      "maxRetries": long,
      "perRetryTimeout": {
        "unit": "s"|"ms",
        "value": long
      },
      "tcpRetryEvents": ["connection-error", ...]
    },
    "timeout": {
      "idle": {
        "unit": "s"|"ms",
        "value": long
      },
      "perRequest": {
        "unit": "s"|"ms",
        "value": long
      }
    }
  },
  "priority": integer,
  "tcpRoute": {
    "action": {
      "weightedTargets": [
        {
          "port": integer,
          "virtualNode": "string",
          "weight": integer
        }
        ...
      ]
    },
    "match": {
      "port": integer
    },
    "timeout": {
      "idle": {
        "unit": "s"|"ms",
        "value": long
      }
    }
  }
}

--virtual-router-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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла аутентификации.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с сертификатом CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для обновления маршрута

Следующий update-route пример использует файл в формате JSON для обновления весов маршрута.

aws appmesh update-route \
    --cli-input-json file://update-route-weighted.json

Содержимое update-route-weighted.json:

{
    "meshName": "app1",
    "routeName": "toVnServiceB-weighted",
    "spec": {
        "httpRoute": {
            "action": {
                "weightedTargets": [
                    {
                        "virtualNode": "vnServiceBv1",
                        "weight": 80
                    },
                    {
                        "virtualNode": "vnServiceBv2",
                        "weight": 20
                    }
                ]
            },
            "match": {
                "prefix": "/"
            }
        }
    },
    "virtualRouterName": "vrServiceB"
}

Вывод:

{
    "route": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted",
            "createdAt": 1563811384.015,
            "lastUpdatedAt": 1563819600.022,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 2
        },
        "routeName": "toVnServiceB-weighted",
        "spec": {
            "httpRoute": {
                "action": {
                    "weightedTargets": [
                        {
                            "virtualNode": "vnServiceBv1",
                            "weight": 80
                        },
                        {
                            "virtualNode": "vnServiceBv2",
                            "weight": 20
                        }
                    ]
                },
                "match": {
                    "prefix": "/"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "vrServiceB"
    }
}

Дополнительную информацию см. в разделе Маршруты в Руководстве пользователя AWS App Mesh.

Вывод

route -> (структура)

Полное описание обновленного маршрута.

meshName -> (строка)

Название сервисной сетки, в которой находится маршрут.

metadata -> (структура)

Связанные метаданные для маршрута.

arn -> (строка)

Полное имя ресурса Amazon Resource Name (ARN).

createdAt -> (временная метка)

Временная метка Unix в секундах, когда ресурс был создан.

lastUpdatedAt -> (временная метка)

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

meshOwner -> (строка)

Идентификатор учетной записи Amazon Web Services IAM владельца сервисной сетки. Если идентификатор учетной записи не ваш, то это идентификатор учетной записи, которая поделилась сеткой с вашей учетной записью. Дополнительную информацию о совместном использовании сеток см. в разделе Работа с совместно используемыми сетками.

resourceOwner -> (строка)

Идентификатор учетной записи Amazon Web Services IAM владельца ресурса. Если идентификатор учетной записи не ваш, то это идентификатор владельца сетки или другой учетной записи, с которой сетка совмещена. Дополнительную информацию о совместном использовании сеток см. в разделе Работа с совместно используемыми сетками.

uid -> (строка)

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

version -> (целое число)

Версия ресурса. Ресурсы создаются с версией 1, и эта версия увеличивается каждый раз при обновлении.

routeName -> (строка)

Название маршрута.

spec -> (структура)

Характеристики маршрута.

grpcRoute -> (структура)

Объект, представляющий спецификацию маршрута gRPC.

action -> (структура)

Объект, представляющий действие, которое следует выполнить при совпадении с шаблоном.

weightedTargets -> (список)

Объект, представляющий цели, к которым направляется трафик при совпадении запроса с маршрутом.

(структура)

Объект, представляющий цель и ее относительный вес. Трафик распределяется между целями в соответствии с их относительным весом. Например, целевой объект с относительным весом 50 получает в пять раз больше трафика, чем целевой объект с относительным весом 10. Общий вес всех целевых объектов должен быть меньше или равен 100.

port -> (целое число)

Целевой порт объекта с весом.

virtualNode -> (строка)

Виртуальный узел, который нужно ассоциировать с целевым объектом с весом.

weight -> (целое число)

Относительный вес целевого объекта с весом.

match -> (структура)

Объект, представляющий критерии для определения совпадения с запросом.

metadata -> (список)

Объект, представляющий данные для сопоставления с запросом.

(структура)

Объект, представляющий метаданные соответствия для маршрута.

invert -> (логическое значение)

Укажите True для сопоставления всего, кроме критериев соответствия. Значение по умолчанию - False.

match -> (структура помеченного союза)

Объект, представляющий данные для сопоставления с запросом.

Примечание

exact -> (строка)

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

prefix -> (строка)

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

range -> (структура)

Объект, представляющий диапазон значений для сопоставления.

end -> (длинное целое число)

Конец диапазона.

start -> (длинное целое число)

Начало диапазона.

regex -> (строка)

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

suffix -> (строка)

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

name -> (строка)

Имя маршрута.

methodName -> (строка)

Имя метода для сопоставления с запросом. Если вы указываете имя, вы также должны указать serviceName.

port -> (целое число)

Номер порта для сопоставления.

serviceName -> (строка)

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

retryPolicy -> (структура)

Объект, представляющий политику повторных попыток.

grpcRetryEvents -> (список)

Укажите хотя бы одно из допустимых значений.

(строка)

httpRetryEvents -> (список)

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

server-error – HTTP-коды состояния 500, 501, 502, 503, 504, 505, 506, 507, 508, 510 и 511
gateway-error – HTTP-коды состояния 502, 503 и 504
client-error – HTTP-код состояния 409
stream-error – Повторная попытка при отказе от потока

(строка)

maxRetries -> (длинное целое число)

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

perRetryTimeout -> (структура)

Таймаут для каждой попытки повторного подключения.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

tcpRetryEvents -> (список)

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

(строка)

timeout -> (структура)

Объект, представляющий типы таймаутов.

idle -> (структура)

Объект, представляющий таймаут простоя. Таймаут простоя ограничивает время простоя соединения. Значение по умолчанию - none.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

perRequest -> (структура)

Объект, представляющий таймаут на запрос. Значение по умолчанию - 15 секунд. Если вы устанавливаете более высокое значение таймаута, убедитесь, что для каждого ресурса App Mesh в разговоре установлено это же значение. Например, если бэкенд виртуального узла использует виртуального маршрутизатора для маршрутизации к другому виртуальному узлу, то таймаут должен быть больше 15 секунд для источника и назначения виртуального узла и маршрута.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

http2Route -> (структура)

Объект, представляющий спецификацию маршрута HTTP/2.

action -> (структура)

Объект, представляющий действие, которое следует выполнить при совпадении с шаблоном.

weightedTargets -> (список)

Объект, представляющий цели, к которым направляется трафик при совпадении запроса с маршрутом.

(структура)

port -> (целое число)

Целевой порт объекта с весом.

virtualNode -> (строка)

Виртуальный узел, который нужно ассоциировать с целевым объектом с весом.

weight -> (целое число)

Относительный вес целевого объекта с весом.

match -> (структура)

Объект, представляющий критерии для определения совпадения с запросом.

headers -> (список)

Заголовки запроса клиента для сопоставления.

(структура)

Объект, представляющий HTTP-заголовок в запросе.

invert -> (логическое значение)

Укажите True для сопоставления всего, кроме критериев соответствия. Значение по умолчанию - False.

match -> (структура помеченного союза)

Объект HeaderMatchMethod.

Примечание

exact -> (строка)

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

prefix -> (строка)

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

range -> (структура)

Объект, представляющий диапазон значений для сопоставления.

end -> (длинное целое число)

Конец диапазона.

start -> (длинное целое число)

Начало диапазона.

regex -> (строка)

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

suffix -> (строка)

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

name -> (строка)

Имя HTTP-заголовка в запросе клиента, на котором будет выполняться сопоставление.

method -> (строка)

Метод запроса клиента для сопоставления. Укажите только один.

path -> (структура)

Путь запроса клиента для сопоставления.

exact -> (строка)

Точный путь для сопоставления.

regex -> (строка)

Регулярное выражение для сопоставления пути.

port -> (целое число)

Номер порта для сопоставления.

prefix -> (строка)

Указывает путь для сопоставления запросов. Этот параметр всегда должен начинаться с /, что само по себе соответствует всем запросам имени виртуальной службы. Вы также можете выполнить сопоставление для маршрутизации запросов по пути. Например, если ваше имя виртуальной службы - my-service.local, и вы хотите, чтобы маршрут соответствовал запросам к my-service.local/metrics, ваш префикс должен быть /metrics.

queryParameters -> (список)

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

(структура)

Объект, представляющий параметр запроса в запросе.

match -> (структура)

Параметр запроса для сопоставления.

exact -> (строка)

Точный параметр запроса для сопоставления.

name -> (строка)

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

scheme -> (строка)

Схема запроса клиента для сопоставления. Укажите только один. Применимо только для маршрутов HTTP2.

retryPolicy -> (структура)

Объект, представляющий политику повторных попыток.

httpRetryEvents -> (список)

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

server-error – HTTP-коды состояния 500, 501, 502, 503, 504, 505, 506, 507, 508, 510 и 511
gateway-error – HTTP-коды состояния 502, 503 и 504
client-error – HTTP-код состояния 409
stream-error – Повторная попытка при отказе от потока

(строка)

maxRetries -> (длинное целое число)

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

perRetryTimeout -> (структура)

Таймаут для каждой попытки повторного подключения.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

tcpRetryEvents -> (список)

(строка)

timeout -> (структура)

Объект, представляющий типы таймаутов.

idle -> (структура)

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

perRequest -> (структура)

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Число единиц времени.

httpRoute -> (структура)

Объект, представляющий спецификацию HTTP-маршрута.

action -> (структура)

Объект, представляющий действие, которое нужно выполнить, если совпадение найдено.

weightedTargets -> (список)

Объект, представляющий целевые узлы, на которые будет перенаправлен трафик при совпадении запроса с маршрутом.

(структура)

Объект, представляющий целевой узел и его относительный вес. Трафик распределяется между целевыми узлами в соответствии с их относительным весом. Например, целевой узел с относительным весом 50 получает в пять раз больше трафика, чем узел с относительным весом 10. Общий вес всех целевых узлов должен быть меньше или равен 100.

port -> (целое число)

Целевой порт объекта с весом.

virtualNode -> (строка)

Виртуальный узел, который следует связать с целевым узлом с весом.

weight -> (целое число)

Относительный вес целевого узла с весом.

match -> (структура)

Объект, представляющий критерии для определения соответствия запроса.

headers -> (список)

Заголовки запроса клиента, на которых следует выполнить проверку соответствия.

(структура)

Объект, представляющий HTTP-заголовок в запросе.

invert -> (булево)

Укажите True, чтобы проверить соответствие всем значениям, кроме указанных критериев. Значение по умолчанию — False.

match -> (структура со значенем)

Объект HeaderMatchMethod.

Примечание

Это структура со значенем. Можно установить только один из следующих ключей верхнего уровня: exact, prefix, range, regex, suffix.

exact -> (строка)

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

prefix -> (строка)

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

range -> (структура)

Объект, представляющий диапазон значений для проверки соответствия.

end -> (длинное целое число)

Конец диапазона.

start -> (длинное целое число)

Начало диапазона.

regex -> (строка)

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

suffix -> (строка)

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

name -> (строка)

Имя HTTP-заголовка в запросе клиента, на котором будет выполняться проверка соответствия.

method -> (строка)

Метод запроса клиента для проверки соответствия. Укажите только один.

path -> (структура)

Путь запроса клиента для проверки соответствия.

exact -> (строка)

Точный путь для проверки соответствия.

regex -> (строка)

Регулярное выражение для проверки соответствия пути.

port -> (целое число)

Номер порта для проверки соответствия.

prefix -> (строка)

Указывает путь для проверки соответствия запросам. Этот параметр всегда должен начинаться с /, что само по себе соответствует всем запросам к имени виртуальной службы. Также можно проверять соответствие запросов по пути. Например, если имя вашей виртуальной службы — my-service.local, и вы хотите, чтобы маршрут соответствовал запросам к my-service.local/metrics, ваш префикс должен быть /metrics.

queryParameters -> (список)

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

(структура)

Объект, представляющий параметр запроса в запросе.

match -> (структура)

Параметр запроса для проверки соответствия.

exact -> (строка)

Точный параметр запроса для проверки соответствия.

name -> (строка)

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

scheme -> (строка)

Схема запроса клиента для проверки соответствия. Укажите только одну. Применимо только для HTTP2-маршрутов.

retryPolicy -> (структура)

Объект, представляющий политику повторных попыток.

httpRetryEvents -> (список)

Укажите хотя бы одно из следующих значений.

server-error – HTTP-коды состояния 500, 501, 502, 503, 504, 505, 506, 507, 508, 510 и 511
gateway-error – HTTP-коды состояния 502, 503 и 504
client-error – HTTP-код состояния 409
stream-error – Повторить попытку при отклонении потока

(строка)

maxRetries -> (длинное целое число)

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

perRetryTimeout -> (структура)

Таймаут для каждой попытки повтора.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Количество единиц времени.

tcpRetryEvents -> (список)

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

(строка)

timeout -> (структура)

Объект, представляющий типы таймаутов.

idle -> (структура)

Объект, представляющий таймаут простоя. Таймаут простоя ограничивает время простоя подключения. Значение по умолчанию — нет.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Количество единиц времени.

perRequest -> (структура)

Объект, представляющий таймаут для каждого запроса. Значение по умолчанию — 15 секунд. Если вы устанавливаете больший таймаут, убедитесь, что это значение установлено для каждого ресурса App Mesh в разговоре. Например, если бэкенд виртуального узла использует виртуальный маршрутизатор для перенаправления на другой виртуальный узел, то таймаут должен быть больше 15 секунд для виртуального узла источника и назначения, а также для маршрута.

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Количество единиц времени.

priority -> (целое число)

Приоритет маршрута. Маршруты сопоставляются на основе указанного значения, где 0 — наивысший приоритет.

tcpRoute -> (структура)

Объект, представляющий спецификацию TCP-маршрута.

action -> (структура)

Действие, которое следует выполнить, если совпадение найдено.

weightedTargets -> (список)

(структура)

port -> (целое число)

Целевой порт объекта с весом.

virtualNode -> (строка)

Виртуальный узел, который следует связать с целевым узлом с весом.

weight -> (целое число)

Относительный вес целевого узла с весом.

match -> (структура)

Объект, представляющий критерии для определения соответствия запроса.

port -> (целое число)

Номер порта для проверки соответствия.

timeout -> (структура)

Объект, представляющий типы таймаутов.

idle -> (структура)

unit -> (строка)

Единица измерения времени.

value -> (длинное целое число)

Количество единиц времени.

status -> (структура)

Статус маршрута.

status -> (строка)

Текущий статус маршрута.

virtualRouterName -> (строка)

Имя виртуального маршрутизатора, с которым связан маршрут.

END_OF_DOCUMENT_MARKER