Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

terminate-game-session

Описание

Завершает игровой сеанс, который в данный момент активен. Используйте эту операцию для завершения любого игрового сеанса, который не находится в состоянии ERROR. Завершение игрового сеанса — наиболее эффективный способ освободить процесс сервера, когда он размещает игровой сеанс, находящийся в плохом состоянии или не завершающийся должным образом. Вы можете использовать эту операцию для завершения игрового сеанса, который размещается на любом типе вычислительных ресурсов Amazon GameLift, включая вычислительные ресурсы для управляемых EC2, управляемых контейнеров и флот-вычислительных ресурсов Anywhere. Серверная игра должна быть интегрирована с серверным SDK Amazon GameLift 5.x или более поздней версии.

Параметры запроса

Запросить завершение для одного игрового сеанса. Укажите идентификатор игрового сеанса и режим завершения. Существуют два потенциальных метода для завершения игрового сеанса:

  • Инициировать плавное завершение, используя стандартную последовательность завершения игрового сеанса. В этом режиме сервис Amazon GameLift запрашивает у процесса сервера, размещающего игровой сеанс, вызвав метод обратного вызова серверного SDK OnProcessTerminate(). Реализация обратного вызова является частью пользовательского кода серверной игры. Она может включать в себя различные действия для плавного завершения игрового сеанса, такие как уведомление игроков, прежде чем остановить процесс сервера.
  • Вызвать немедленное завершение игрового сеанса. В этом режиме сервис Amazon GameLift принимает меры для остановки процесса сервера, что завершает игровой сеанс без стандартной последовательности завершения игрового сеанса.
Результаты

При успешном выполнении инициируется завершение игрового сеанса. В ходе этой операции статус игрового сеанса изменяется на TERMINATING. После завершения процесс сервера, который размещал игровой сеанс, был остановлен и заменён новым процессом сервера, готовым к размещению нового игрового сеанса. Статус старого игрового сеанса изменяется на TERMINATED со значением причины, указывающей используемый метод завершения.

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

Добавление Amazon GameLift в серверную игру

Справочник по серверному SDK Amazon GameLift 5 для OnProcessTerminate() (C++ ) (C# ) (Unreal ) (Go )

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

Синопсис

  terminate-game-session
--game-session-id <value>
--termination-mode <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-session-id (строка)

Уникальный идентификатор игрового сеанса, который требуется завершить. URI игрового сеанса имеет следующий формат: arn:aws:gamelift:<location>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

--termination-mode (строка)

Метод, который нужно использовать для завершения игрового сеанса. Доступные методы включают:

  • TRIGGER_ON_PROCESS_TERMINATE – Принуждает сервис Amazon GameLift отправить обратный вызов OnProcessTerminate() процессу сервера и инициировать стандартную последовательность завершения игрового сеанса. Метод OnProcessTerminate, реализованный в коде серверной игры, должен включать вызов действия серверного SDK ProcessEnding(), что является способом сигнализации процессу сервера об окончании игрового сеанса в Amazon GameLift. Если процесс сервера не вызовет ProcessEnding(), завершение игрового сеанса не будет успешно завершено.
  • FORCE_TERMINATE – Принуждает сервис Amazon GameLift немедленно остановить процесс сервера. Amazon GameLift предпринимает действия (в зависимости от типа флота) для остановки процесса сервера без стандартной последовательности завершения игрового сеанса.

Примечание

Этот метод недоступен для игровых сеансов, работающих на флагах Anywhere, если флот не развернут с агентом Amazon GameLift. В этом случае запрос на принудительное завершение приводит к исключению недействительного или ошибочного запроса.

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

  • TRIGGER_ON_PROCESS_TERMINATE
  • FORCE_TERMINATE

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

Вывод

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

Свойства, описывающие игровой сеанс.

Игровой сеанс в активном состоянии может принимать игроков. Когда игровой сеанс завершается, его статус устанавливается в TERMINATED .

Amazon GameLift сохраняет ресурс игрового сеанса в течение 30 дней после его завершения. Вы можете повторно использовать значения маркеров идемпотентности после этого времени. Журналы игрового сеанса сохраняются в течение 14 дней.

Все API по задачам

GameSessionId -> (строка)

Уникальный идентификатор игрового сеанса. ARN игрового сеанса имеет следующий формат: arn:aws:gamelift:<location>::gamesession/<fleet ID>/<custom ID string or idempotency token> .

Name -> (строка)

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

FleetId -> (строка)

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

FleetArn -> (строка)

Amazon Resource Name (ARN) , связанный с флотом GameLift, на котором работает этот игровой сеанс.

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

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

TerminationTime -> (метка времени)

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

CurrentPlayerSessionCount -> (целое число)

Количество игроков, в данный момент находящихся в игровом сеансе.

MaximumPlayerSessionCount -> (целое число)

Максимальное количество игроков, которые могут быть подключены к игровому сеансу одновременно.

Status -> (строка)

Текущий статус игрового сеанса. Игровой сеанс должен иметь статус ACTIVE , чтобы иметь игровые сеансы.

StatusReason -> (строка)

Предоставляет дополнительную информацию о статусе игрового сеанса.

  • INTERRUPTED – Игровой сеанс был размещен на экземпляре EC2 Spot, который был возвращен, что привело к остановке активного игрового сеанса.
  • TRIGGERED_ON_PROCESS_TERMINATE – Игровой сеанс был остановлен вызовом TerminateGameSession с режимом завершения TRIGGER_ON_PROCESS_TERMINATE .
  • FORCE_TERMINATED – Игровой сеанс был остановлен вызовом TerminateGameSession с режимом завершения FORCE_TERMINATE .

GameProperties -> (список)

Набор пар ключ-значение, которые могут хранить пользовательские данные в игровом сеансе. Например: {"Key": "difficulty", "Value": "novice"} .

(структура)

Эта пара ключ-значение может хранить пользовательские данные об игровом сеансе. Например, вы можете использовать GameProperty для отслеживания карты игрового сеанса, уровня сложности или оставшегося времени. Уровень сложности можно указать следующим образом: {"Key": "difficulty", "Value":"Novice"} .

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

Примеры работы со свойствами игры см. в разделе Создать игровой сеанс со свойствами .

Key -> (строка)

Идентификатор свойства игры.

Value -> (строка)

Значение свойства игры.

IpAddress -> (строка)

IP-адрес игрового сеанса. Для подключения к серверу игры Amazon GameLift приложение должно иметь как IP-адрес, так и номер порта.

DnsName -> (строка)

Идентификатор DNS, назначенный экземпляру, на котором выполняется игровой сеанс. Значения имеют следующий формат:

  • Флоты с поддержкой TLS: <unique identifier>.<region identifier>.amazongamelift.com .
  • Флоты без поддержки TLS: ec2-<unique identifier>.compute.amazonaws.com . (См. Адресация IP-адресов экземпляров Amazon EC2 .)

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

Port -> (целое число)

Номер порта для игрового сеанса. Для подключения к серверу игры Amazon GameLift приложение должно иметь как IP-адрес, так и номер порта.

PlayerSessionCreationPolicy -> (строка)

Указывает, принимает ли игровой сеанс новых игроков.

CreatorId -> (строка)

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

GameSessionData -> (строка)

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

MatchmakerData -> (строка)

Информация о процессе сопоставления, который привел к игровому сеансу, если использовалось сопоставление. Данные представлены в формате JSON, отформатированном как строка. Информация включает идентификатор сопоставления, а также атрибуты игроков и назначение команд. Дополнительные сведения о данных сопоставления см. в разделе Данные сопоставления . Данные сопоставления обновляются всякий раз, когда новые игроки добавляются во время успешного заполнения (см. Запуск заполнения сопоставления ).

Location -> (строка)

Расположение флота, на котором выполняется игровой сеанс. Это значение может указывать на домашнюю область флота или удаленное местоположение. Расположение выражается в виде кода региона Amazon Web Services, например, us-west-2 .

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

Spec-Zone.ru

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