Spec-Zone.ru › AWS CLI v2

[ aws . networkflowmonitor ]

Получение результатов запроса для мониторинга сетевого трафика (Workload Insights — топ-контрибьюторы)

Описание

Возвращает данные по запросу с помощью интерфейса Network Flow Monitor. Вы указываете запрос, для которого нужно вернуть результаты, предоставив идентификатор запроса и имя монитора.

Этот запрос возвращает топ-контрибьюторы для определённого охвата данных Workload Insights. Workload Insights предоставляет общий обзор данных о производительности сетевого трафика, собранных агентами. Чтобы получить данные о топ-контрибьюторах, см. GetQueryResultsWorkloadInsightsTopContributorsData .

Создайте идентификатор запроса для этого вызова, вызвав соответствующий API-метод для запуска запроса, StartQueryWorkloadInsightsTopContributors . Используйте идентификатор охвата, который был возвращен для вашей учетной записи CreateScope .

Топ-контрибьюторы в Network Flow Monitor — это сетевые потоки с наибольшими значениями для определенного типа метрики, связанной с областью (для Workload Insights) или монитором.

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

get-query-results-workload-insights-top-contributors — это страничная операция. Для получения всего набора результатов могут потребоваться несколько API-вызовов. Вы можете отключить страничную навигацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на страничном запросе, аргумент --query должен извлекать данные из результатов следующих выражений запроса: topContributors

Синтаксис

  get-query-results-workload-insights-top-contributors
--scope-id <value>
--query-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--scope-id (строка)

Идентификатор охвата, включающего ресурсы, для которых требуется получить результаты данных. Идентификатор охвата — это сгенерированный внутри идентификатор, который включает все ресурсы для конкретной учетной записи корневого уровня.

--query-id (строка)

Идентификатор запроса. Идентификатор запроса — это сгенерированный внутри идентификатор конкретного запроса, возвращённого из API-вызова для запуска запроса.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения, используя предоставленное значение JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания, с какой точки начать страничную навигацию. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе «Страничная навигация» в руководстве пользователя AWS CLI.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания AWS-сервиса.

Примеры использования см. в разделе «Страничная навигация» в руководстве пользователя AWS CLI.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Чтобы продолжить страничную навигацию, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Страничная навигация» в руководстве пользователя AWS CLI.

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

Примеры

Примечание

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

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

Получение топ-контрибьюторов для Workload Insights

Следующий пример get-query-results-workload-insights-top-contributors возвращает данные для указанного запроса.

aws networkflowmonitor get-query-results-workload-insights-top-contributors \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id 1fc423d3-b144-37a6-80e6-e2c7d26eea0c

Вывод:

{
    "topContributors": [
        {
            "accountId": "123456789012",
            "localSubnetId": "subnet-0a5b30fb95dca2c14",
            "localAz": "use1-az6",
            "localVpcId": "vpc-03ea55eeda25adbb0",
            "localRegion": "us-east-1",
            "remoteIdentifier": "",
            "value": 908443,
            "localSubnetArn": "arn:aws:ec2:us-east-1:123456789012:subnet/subnet-0a5b30fb95dca2c14",
            "localVpcArn": "arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0"
        }
    ]
}

Дополнительную информацию см. в разделе «Оценка сетевых потоков с помощью Workload Insights» в руководстве пользователя Amazon CloudWatch.

Вывод

topContributors -> (список)

Основные сетевые потоки-контрибьюторы в целом для определенного типа метрики, например, количество повторных передач.

(структура)

Строка для основного контрибьютора для охвата.

accountId -> (строка)

Идентификатор учетной записи для конкретной строки данных.

localSubnetId -> (строка)

Идентификатор подсети для локального ресурса.

localAz -> (строка)

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

localVpcId -> (строка)

Идентификатор VPC для локального ресурса.

localRegion -> (строка)

Регион Amazon Web Services, в котором находится локальный ресурс.

remoteIdentifier -> (строка)

Идентификатор удаленного ресурса.

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

Значение метрики.

localSubnetArn -> (строка)

Amazon Resource Name (ARN) локальной подсети.

localVpcArn -> (строка)

Amazon Resource Name (ARN) локальной VPC.

nextToken -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API