Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

create-game-session

Описание

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

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

Вы можете использовать эту операцию следующим образом:

  • Для создания игровой сессии на экземпляре в домашнем регионе флота укажите идентификатор флота или псевдонима, а также конфигурацию вашей игровой сессии.
  • Для создания игровой сессии на экземпляре в удаленном расположении флота укажите идентификатор флота или псевдонима, а также имя расположения, вместе с конфигурацией вашей игровой сессии.
  • Для создания игровой сессии на экземпляре в флоте Anywhere укажите пользовательское расположение флота.

В случае успеха Amazon GameLift инициирует процесс запуска новой игровой сессии и возвращает объект GameSession, содержащий конфигурацию и статус игровой сессии. Когда статус игровой сессии равен ACTIVE, он обновляется с информацией о подключении, и вы можете создать игровые сессии для данной игровой сессии. По умолчанию вновь созданные игровые сессии открыты для новых игроков. Вы можете ограничить доступ новых игроков, используя UpdateGameSession для изменения политики создания игровых сессий.

Amazon GameLift сохраняет журналы активных сессий в течение 14 дней. Для доступа к журналам вызовите GetGameSessionLogUrl для загрузки файлов журнала.

Доступно в Amazon GameLift Local.

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

Запустить игровую сессию

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

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

Синтаксис

  create-game-session
[--fleet-id <value>]
[--alias-id <value>]
--maximum-player-session-count <value>
[--name <value>]
[--game-properties <value>]
[--creator-id <value>]
[--game-session-id <value>]
[--idempotency-token <value>]
[--game-session-data <value>]
[--location <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]

Параметры

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

Уникальный идентификатор флота для создания игровой сессии. Можно использовать либо идентификатор, либо ARN значения. Каждый запрос должен ссылаться либо на идентификатор флота, либо на идентификатор псевдонима, но не на оба.

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

Уникальный идентификатор псевдонима, связанного с флотом для создания игровой сессии. Можно использовать либо идентификатор, либо ARN значения. Каждый запрос должен ссылаться либо на идентификатор флота, либо на идентификатор псевдонима, но не на оба.

--maximum-player-session-count (целое число)

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

--name (строка)

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

--game-properties (список)

Набор пар «ключ-значение», которые могут хранить пользовательские данные в игровой сессии. Например: {"Key": "difficulty", "Value": "novice"}. Пример см. в Create a game session with custom properties.

(структура)

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

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

Примеры работы со свойствами игры см. в Create a game session with properties.

Ключ -> (строка)

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

Значение -> (строка)

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

Сокращенный синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

Уникальный идентификатор игрока или сущности, создающей игровую сессию.

Если вы добавите политику ограничения создания ресурсов в флот, операция CreateGameSession требует CreatorId. Amazon GameLift ограничивает количество запросов на создание игровых сессий с тем же CreatorId в определенный период времени.

Если у вашего флота нет политики ограничения создания ресурсов и вы предоставляете CreatorId в запросах CreateGameSession, Amazon GameLift ограничивает запросы одним запросом на CreatorId в секунду.

Чтобы не ограничивать запросы CreateGameSession с тем же CreatorId, не предоставляйте CreatorId в запросе CreateGameSession.

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

Этот параметр устарел. Используйте ``IdempotencyToken`` вместо него.

Пользовательская строка, которая уникально идентифицирует запрос на новую игровую сессию. Максимальная длина маркера — 48 символов. Если указано, эта строка включена в идентификатор новой игровой сессии.

--idempotency-token (строка)

Пользовательская строка, которая уникально идентифицирует запрос новой игровой сессии. Это полезно для обеспечения обработки запросов игровых сессий с тем же маркером идемпотентности только один раз. Последующие запросы с той же строкой возвращают исходный объект GameSession с обновленным статусом. Максимальная длина маркера — 48 символов. Если указано, эта строка включена в идентификатор новой игровой сессии. ARN игровой сессии имеет следующий формат: arn:aws:gamelift:<location>::gamesession/<fleet ID>/<custom ID string or idempotency token>. Маркеры идемпотентности используются в течение 30 дней после завершения игровой сессии; объекты игровой сессии сохраняются в течение этого периода времени, а затем удаляются.

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

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

--location (строка)

Удаленное расположение флота для размещения новой игровой сессии. Если этот параметр не задан, новая игровая сессия размещается в домашнем регионе флота. Укажите удаленное расположение с кодом региона Amazon Web Services, например, us-west-2. При использовании флота Anywhere этот параметр требуется и должен быть установлен на пользовательское расположение флота Anywhere.

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

Вывод

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

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

GameSessionId -> (строка)

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

Имя -> (строка)

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

FleetId -> (строка)

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

FleetArn -> (строка)

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

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

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

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

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

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

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

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

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

Статус -> (строка)

Текущий статус игровой сессии. Игровая сессия должна иметь статус 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"} .

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

Примеры работы со свойствами сессии см. в разделе Create a game session with properties .

Ключ -> (строка)

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

Значение -> (строка)

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

IpAddress -> (строка)

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

DnsName -> (строка)

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

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

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

Порт -> (целое число)

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

PlayerSessionCreationPolicy -> (строка)

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

CreatorId -> (строка)

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

GameSessionData -> (строка)

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

MatchmakerData -> (строка)

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

Расположение -> (строка)

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

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

Spec-Zone.ru

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