Spec-Zone.ru › AWS CLI v2

[ aws . deadline ]

получение-статистики-агрегирования-сессий

Описание

Получает набор статистических данных для очередей или ферм. Прежде чем вы сможете вызвать операцию GetSessionStatisticsAggregation, необходимо сначала вызвать операцию StartSessionsStatisticsAggregation. Статистические данные доступны в течение 1 часа после вызова операции StartSessionsStatisticsAggregation.

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

get-sessions-statistics-aggregation является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: statistics

Синтаксис

  get-sessions-statistics-aggregation
--farm-id <value>
--aggregation-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]

Параметры

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

Идентификатор фермы, который необходимо включить в статистику. Он должен совпадать с идентификатором фермы, используемым в вызове операции StartSessionsStatisticsAggregation.

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

Идентификатор, возвращенный операцией StartSessionsStatisticsAggregation, который идентифицирует агрегированные статистические данные.

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

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

Маркер, указывающий, с какой точки начать постраничный вывод. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

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

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

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

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

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

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

--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.

Вывод

statistics -> (список)

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

(структура)

Список статистических данных для сессии.

queueId -> (строка)

Идентификатор очереди.

fleetId -> (строка)

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

jobId -> (строка)

Идентификатор задачи.

jobName -> (строка)

Название задачи.

userId -> (строка)

Идентификатор пользователя.

usageType -> (строка)

Тип использования для статистических данных.

licenseProduct -> (строка)

Лицензионный продукт.

instanceType -> (строка)

Тип экземпляра.

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

Количество экземпляров в списке статистических данных.

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

Как статистические данные должны отображаться в USD. Доступны варианты: минимум, максимум, среднее или сумма.

min -> (двойное значение)

Минимальное значение статистических данных об использовании.

max -> (двойное значение)

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

avg -> (двойное значение)

Среднее значение статистических данных об использовании.

sum -> (двойное значение)

Сумма статистических данных об использовании.

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

Общее агрегированное время выполнения.

min -> (двойное значение)

Минимальное значение статистических данных об использовании.

max -> (двойное значение)

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

avg -> (двойное значение)

Среднее значение статистических данных об использовании.

sum -> (двойное значение)

Сумма статистических данных об использовании.

aggregationStartTime -> (метка времени)

Начальное время агрегирования.

aggregationEndTime -> (метка времени)

Конечное время агрегирования.

nextToken -> (строка)

Если Deadline Cloud возвращает nextToken, значит, доступно больше результатов. Значение nextToken — уникальный маркер постраничного вывода для каждой страницы. Чтобы получить следующую страницу, снова вызовите операцию, используя возвращенный маркер. Не изменяйте другие аргументы. Если больше результатов нет, то nextToken устанавливается в значение null. Каждый маркер постраничного вывода действует 24 часа. Если вы предоставляете недействительный маркер, то вы получите ошибку HTTP 400 ValidationException.

status -> (строка)

Статус агрегированных результатов. Агрегирование может завершиться неудачно или с ошибкой по времени, если результаты слишком велики. В этом случае вы можете вызвать операцию StartSessionsStatisticsAggregation после сокращения периода агрегирования, уменьшения количества очередей или флотов в агрегировании или увеличения длительности периода.

Если вы вызываете операцию StartSessionsStatisticsAggregation, когда статус равен IN_PROGRESS, вы получите ThrottlingException.

statusMessage -> (строка)

Сообщение, описывающее состояние.

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

Spec-Zone.ru

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