Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

register-game-server

Описание

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

Создаёт новый ресурс игрового сервера и уведомляет Amazon GameLift FleetIQ о том, что игровой сервер готов принимать игровой процесс и игроков. Эта операция вызывается процессом игрового сервера, работающим на экземпляре в группе игровых серверов. Регистрация игровых серверов позволяет Amazon GameLift FleetIQ отслеживать доступные игровые серверы и позволяет клиентам и сервисам игры выбирать игровой сервер для новой игровой сессии.

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

После успешной регистрации игровой сервер переходит в состояние AVAILABLE. Запрос на регистрацию игрового сервера может завершиться ошибкой, если экземпляр, на котором он работает, находится в процессе выключения в рамках балансировки экземпляров или деятельности по уменьшению масштаба.

Узнать больше

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

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

Синтаксис

  register-game-server
--game-server-group-name <value>
--game-server-id <value>
--instance-id <value>
[--connection-info <value>]
[--game-server-data <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 (строка)

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

--game-server-id (строка)

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

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

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

--connection-info (строка)

Информация, необходимая для установления входящих клиентских подключений к игровому серверу. Это может включать IP-адрес и порт, имя DNS и другую информацию.

--game-server-data (строка)

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

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

Вывод

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

Объект, описывающий только что зарегистрированный игровой сервер.

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"). После регистрации игрового сервера это свойство изменяется только при обновлении игрового сервера с указанием значения проверки работоспособности.

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

Spec-Zone.ru

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