Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

describe-game-server-group

Описание

Данная операция используется с решением Amazon GameLift FleetIQ и группами серверов игры.

Получает информацию о группе серверов игры. Данная операция возвращает только свойства, относящиеся к Amazon GameLift FleetIQ. Для просмотра или изменения свойств соответствующей группы Auto Scaling, таких как шаблон запуска, политики автомасштабирования и максимальный/минимальный размер группы, обратитесь к группе Auto Scaling напрямую.

Чтобы получить атрибуты группы серверов игры, укажите имя или значение ARN. В случае успеха возвращается объект GameServerGroup.

Дополнительная информация

Руководство по Amazon GameLift FleetIQ

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

Синтаксис

  describe-game-server-group
--game-server-group-name <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]

Параметры

--game-server-group-name (строка)

Уникальный идентификатор группы серверов игры. Используйте имя или значение ARN.

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Объект со свойствами настроек для запрашиваемого ресурса группы серверов игры.

GameServerGroupName -> (строка)

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

GameServerGroupArn -> (строка)

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

RoleArn -> (строка)

Amazon Resource Name (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 Instances и On-Demand Instances в группе серверов игры. Доступные варианты включают:

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

GameServerProtectionPolicy -> (строка)

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

AutoScalingGroupArn -> (строка)

Сгенерированный уникальный ID для группы 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 -> (временная метка)

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

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

Spec-Zone.ru

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