Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

list-game-server-groups

Описание

Отображает список групп серверов для игр.

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

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

Синтаксис

  list-game-server-groups
[--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]

Параметры

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

Вывод

GameServerGroups -> (список)

Группы серверов игр — группы серверов игр.

(структура)

Этот тип данных используется с Amazon GameLift FleetIQ и группами серверов игр.

Свойства, описывающие ресурс группы серверов игр. Группа серверов игр управляет определенными свойствами, связанными с соответствующей группой Amazon EC2 Auto Scaling.

Группа серверов игр создается успешным вызовом CreateGameServerGroup и удаляется путем вызова DeleteGameServerGroup . Активность группы серверов игр может быть временно приостановлена и возобновлена путем вызова SuspendGameServerGroup и ResumeGameServerGroup соответственно.

GameServerGroupName -> (строка)

Идентификатор, определенный разработчиком, для группы серверов игр. Название уникально для каждой области в каждой учетной записи Amazon Web Services.

GameServerGroupArn -> (строка)

Сгенерированный уникальный идентификатор для группы серверов игр.

RoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) для роли IAM, которая позволяет Amazon GameLift получать доступ к группам Amazon EC2 Auto Scaling.

InstanceDefinitions -> (список)

Набор типов экземпляров Amazon EC2, которые Amazon GameLift FleetIQ может использовать при балансировке и автоматическом масштабировании экземпляров в соответствующей группе Auto Scaling.

(структура)

Этот тип данных используется с Amazon GameLift FleetIQ и группами серверов игр.

Допустимый тип экземпляра для группы серверов игр. Все группы серверов игр должны иметь как минимум два определенных типа экземпляров. Amazon GameLift FleetIQ периодически оценивает жизнеспособность каждого определенного типа экземпляра. Затем он обновляет группу Auto Scaling со списком жизнеспособных типов экземпляров.

InstanceType -> (строка)

Обозначение типа экземпляра Amazon EC2.

WeightedCapacity -> (строка)

Взвешивание экземпляра, которое указывает, насколько этот тип экземпляра вносит вклад в общую емкость группы серверов игр. Веса экземпляров используются Amazon GameLift FleetIQ для расчета стоимости экземпляра на час и лучшего определения наиболее экономичных вариантов. Подробную информацию о взвешивании емкости экземпляров см. в руководстве пользователя Amazon Elastic Compute Cloud Auto Scaling в разделе Взвешивание экземпляров. Значение по умолчанию — «1».

BalancingStrategy -> (строка)

Указывает, как Amazon GameLift FleetIQ балансирует использование экземпляров Spot и On-Demand в группе серверов игры. Доступные методы включают следующие:

  • SPOT_ONLY - В группе серверов игр используются только экземпляры Spot. Если экземпляры Spot недоступны или не подходят для размещения игр, группа серверов игр не предоставляет емкость для размещения, пока экземпляры Spot снова не станут доступны. До этого момента новые экземпляры не запускаются, а существующие неподходящие экземпляры Spot завершают работу (после окончания текущей игры) и не заменяются.
  • SPOT_PREFERRED - (значение по умолчанию) Экземпляры Spot используются всякий раз, когда они доступны в группе серверов игр. Если экземпляры Spot недоступны, группа серверов игр продолжает предоставлять емкость для размещения, переходя на экземпляры On-Demand. Существующие неподходящие экземпляры Spot завершают работу (после окончания текущей игры) и заменяются новыми экземплярами On-Demand.
  • ON_DEMAND_ONLY - В группе серверов игр используются только экземпляры On-Demand. Экземпляры Spot не используются, даже если они доступны, в то время как эта стратегия балансировки активна.

GameServerProtectionPolicy -> (строка)

Флаг, указывающий, защищены ли экземпляры в группе серверов игр от преждевременного завершения. Незащищенные экземпляры, на которых работают активные серверы игр, могут быть завершены во время события уменьшения масштаба, что приведет к выходу игроков из игры. Защищенные экземпляры не могут быть завершены, пока на них работают активные серверы игр, за исключением случая принудительного удаления группы серверов игр (см. ). Исключением является случай с экземплярами Spot, которые могут быть завершены Amazon Web Services независимо от статуса защиты.

AutoScalingGroupArn -> (строка)

Сгенерированный уникальный идентификатор для группы Amazon EC2 Auto Scaling, связанной с этой группой серверов игр.

Status -> (строка)

Текущий статус группы серверов игр. Возможные статусы включают:

  • NEW - Amazon GameLift FleetIQ проверил запрос CreateGameServerGroup().
  • ACTIVATING - Amazon GameLift FleetIQ создает группу серверов игр, что включает создание группы Auto Scaling в вашей учетной записи Amazon Web Services.
  • ACTIVE - Группа серверов игр успешно создана.
  • DELETE_SCHEDULED - Получен запрос на удаление группы серверов игр.
  • DELETING - Amazon GameLift FleetIQ получил действительный запрос DeleteGameServerGroup() и обрабатывает его. Amazon GameLift FleetIQ должен сначала завершить и освободить хосты, прежде чем удалить группу Auto Scaling и группу серверов игр.
  • DELETED - Группа серверов игр успешно удалена.
  • ERROR - Асинхронные процессы активации или удаления группы серверов игр завершились сбоем, что привело к ошибочному состоянию.

StatusReason -> (строка)

Дополнительная информация о текущем статусе группы серверов игр. Эта информация может предоставить дополнительные сведения о группах, находящихся в статусе ERROR.

SuspendedActions -> (список)

Список активностей, которые в настоящее время приостановлены для этой группы серверов игр. Если это свойство пустое, все активности происходят.

(строка)

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

Временная метка, указывающая время создания этого объекта данных. Формат — число, выраженное в миллисекундах по времени Unix (например, "1469498468.057").

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

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

NextToken -> (строка)

Укажите маркер постраничной навигации из предыдущего запроса для получения следующей страницы результатов.

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

Spec-Zone.ru

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