Spec-Zone.ru › AWS CLI v2

[ aws . networkflowmonitor ]

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

Описание

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

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

Ведущими участниками в мониторинге сетевых потоков являются сетевые потоки с наибольшими значениями для определенного типа метрики, относящейся к области (для анализа рабочей нагрузки) или монитору.

Ведущие сетевые потоки в целом для определенного типа метрики, например, количество повторных передач.

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

Синтаксис

  get-query-status-workload-insights-top-contributors-data
--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 (строка)

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

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

Использовать определенный профиль из файла с данными.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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-data пример отображает текущее состояние запроса в указанной учетной записи.

aws networkflowmonitor get-query-status-workload-insights-top-contributors-data \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id 4333754d-8ae1-3f29-b6b7-c36db2e7f8ac

Вывод:

{
    "status": "SUCCEEDED"
}

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

Вывод

status -> (строка)

Состояние запроса данных о ведущих участниках.

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

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

Spec-Zone.ru

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