Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

list-game-servers

Описание

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

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

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

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

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

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

Синтаксис

  list-game-servers
--game-server-group-name <value>
[--sort-order <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]

Параметры

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

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

--sort-order (строка)

Указывает, как сортировать возвращаемые данные по метке времени регистрации игрового сервера. Используйте ASCENDING, чтобы получить сначала самые старые игровые серверы, или используйте DESCENDING, чтобы получить сначала самые новые игровые серверы. Если этот параметр опущен, игровые серверы возвращаются без определенного порядка.

Возможные значения:

  • ASCENDING
  • DESCENDING

--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 для вывода.

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

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

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

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

Вывод

GameServers -> (список)

Коллекция объектов игровых серверов, соответствующих запросу.

(структура)

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

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

Игровой сервер создается успешным вызовом RegisterGameServer и удаляется путем вызова DeregisterGameServer. Игровой сервер заявляется о размещении игровой сессии путем вызова ClaimGameServer.

GameServerGroupName -> (строка)

Уникальный идентификатор группы игровых серверов, где работает игровой сервер.

GameServerGroupArn -> (строка)

Идентификатор ARN группы игровых серверов, где находится игровой сервер.

GameServerId -> (строка)

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

InstanceId -> (строка)

Уникальный идентификатор экземпляра, на котором работает игровой сервер. Этот идентификатор доступен в метаданных экземпляра. Идентификаторы экземпляров EC2 используют формат из 17 символов, например: i-1234567890abcdef0.

ConnectionInfo -> (строка)

Порт и IP-адрес, которые необходимо использовать для установления клиентского подключения к игровому серверу.

GameServerData -> (строка)

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

ClaimStatus -> (строка)

Указывает, когда доступный игровой сервер был зарезервирован для игры, но еще не начал размещать игру. После заявления игровой сервер остается в статусе CLAIMED максимум одну минуту. В течение этого времени игровые клиенты подключаются к игровому серверу, чтобы начать игру и заставить игровой сервер обновить статус использования. Через одну минуту статус заявления на игровой сервер возвращается к null.

UtilizationStatus -> (строка)

Указывает, доступен ли игровой сервер для новых игр или занят. Возможные статусы:

  • AVAILABLE — игровой сервер доступен для заявления. Игровой сервер, который был заявлен, остается в этом статусе до тех пор, пока он не сообщит об активности размещения игры.
  • UTILIZED — игровой сервер в настоящее время размещает игровые сессии с игроками.

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

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

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

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

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

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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