Spec-Zone.ru › AWS CLI v2

[ aws . networkflowmonitor ]

get-query-status-workload-insights-top-contributors

Описание

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

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

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

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

Синтаксис

  get-query-status-workload-insights-top-contributors
--scope-id <value>
--query-id <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]

Параметры

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

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

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

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

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

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Для получения статуса запроса

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

aws networkflowmonitor get-query-status-workload-insights-top-contributors \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id f2a87c70-3e5a-362e-8beb-4747d13d8419

Вывод:

{
    "status": "SUCCEEDED"
}

Дополнительную информацию см. в разделе Оценка сетевых потоков с помощью анализа рабочей нагрузки в Руководстве пользователя Amazon CloudWatch.

Вывод

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

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

  • QUEUED : Запрос запланирован на выполнение.
  • RUNNING : Запрос выполняется, но не завершен.
  • SUCCEEDED : Запрос успешно завершен.
  • FAILED : Запрос завершился неудачно из-за ошибки.
  • CANCELED : Запрос был отменен.

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

Spec-Zone.ru

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