Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

claim-game-server

Описание

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

Определяет доступный игровой сервер и временно резервирует его для размещения игрового процесса и игроков. Эта операция вызывается из игрового клиента или клиентской службы (например, системы подбора игроков) для запроса ресурсов размещения для новой игровой сессии. В ответ Amazon GameLift FleetIQ находит доступный игровой сервер, устанавливает его в статус CLAIMED на 60 секунд и возвращает информацию о подключении, которую игроки могут использовать для подключения к игровому серверу.

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

При успешном резервировании игрового сервера возвращается информация о подключении. Статус использования зарезервированного игрового сервера остается AVAILABLE, пока статус резервирования установлен в CLAIMED в течение 60 секунд. Этот период времени дает игровому серверу время для обновления его статуса на UTILIZED после подключения игроков. Если статус игрового сервера не обновится в течение 60 секунд, игровой сервер вернется в незарезервированное состояние и станет доступен для резервирования другим запросом. Период резервирования является фиксированной величиной и не настраивается.

Если вы пытаетесь зарезервировать определенный игровой сервер, этот запрос завершится неудачей в следующих случаях:

  • Если статус использования игрового сервера UTILIZED.
  • Если статус резервирования игрового сервера CLAIMED.
  • Если игровой сервер работает на экземпляре в состоянии DRAINING, а предоставленный параметр фильтрации не разрешает размещение на экземплярах типа DRAINING.

Подробнее

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

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

Краткое описание

  claim-game-server
--game-server-group-name <value>
[--game-server-id <value>]
[--game-server-data <value>]
[--filter-option <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 (строка)

Уникальный идентификатор группы игровых серверов, где работает игровой сервер. Если вы не указываете игровой сервер для резервирования, это значение указывает, где Amazon GameLift FleetIQ должен искать доступный игровой сервер для резервирования.

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

Пользовательская строка, уникально идентифицирующая игровой сервер для резервирования. Если этот параметр оставлен пустым, Amazon GameLift FleetIQ ищет доступный игровой сервер в указанной группе игровых серверов.

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

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

--filter-option (структура)

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

InstanceStatuses -> (список)

Список статусов экземпляров, на которых могут быть зарезервированы игровые серверы. Если задан, список должен содержать статус ACTIVE.

(строка)

Короткая синтаксическая запись:

InstanceStatuses=string,string

Синтаксис JSON:

{
  "InstanceStatuses": ["ACTIVE"|"DRAINING", ...]
}

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