describe-game-session-placement
Описание
Получает информацию, включая текущий статус, о запросе размещения игровой сессии.
Для получения данных о размещении игровой сессии укажите идентификатор размещения.
Эта операция не предназначена для непрерывного вызова для отслеживания статуса игровой сессии. Такая практика может привести к превышению лимита API, что результатом ошибок. Вместо этого необходимо настроить тему Amazon Simple Notification Service (SNS) для получения уведомлений от FlexMatch или очередей. Непрерывное опробование с DescribeGameSessionPlacement должно использоваться только для игр в разработке с низким использованием игровых сессий.
См. также: Документация API AWS
Синтаксис
describe-game-session-placement
--placement-id <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]
Параметры
--placement-id (строка)
--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
- таблица
- 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.
Вывод
GameSessionPlacement -> (структура)
Объект, описывающий запрос на размещение игровой сессии.
PlacementId -> (строка)
GameSessionQueueName -> (строка)
Status -> (строка)
Текущий статус запроса на размещение игровой сессии.
- PENDING – Запрос на размещение находится в очереди ожидания обработки. Свойства игровой сессии еще не окончательны.
- FULFILLED – Новая игровая сессия успешно размещена. Свойства игровой сессии теперь окончательны.
- CANCELLED – Запрос на размещение был отменен.
- TIMED_OUT – Новая игровая сессия не была успешно создана до истечения лимита времени. Вы можете повторно отправить запрос на размещение по мере необходимости.
- FAILED – Amazon GameLift не может завершить процесс размещения игровой сессии. Общие причины: завершение игровой сессии до завершения процесса размещения или непредвиденная внутренняя ошибка.
GameProperties -> (список)
Набор пар ключ-значение, которые могут хранить пользовательские данные в игровой сессии. Например: {"Key": "difficulty", "Value": "novice"} .
(структура)
Эта пара ключ-значение может хранить пользовательские данные об игровой сессии. Например, вы можете использовать GameProperty для отслеживания карты игровой сессии, уровня сложности или оставшегося времени. Уровень сложности можно указать так: {"Key": "difficulty", "Value":"Novice"} .
Вы можете задавать свойства игры при создании игровой сессии. Вы также можете изменять свойства игры активной игровой сессии. При поиске игровых сессий вы можете фильтровать по ключам и значениям свойств игры. Вы не можете удалять свойства игры из игровой сессии.
Примеры работы со свойствами игры см. в Create a game session with properties .
Key -> (строка)
Value -> (строка)
MaximumPlayerSessionCount -> (целое число)
GameSessionName -> (строка)
GameSessionId -> (строка)
FULFILLED .GameSessionArn -> (строка)
FULFILLED .GameSessionRegion -> (строка)
FULFILLED .PlayerLatencies -> (список)
Набор значений, выраженных в миллисекундах, указывающих на количество задержки, которое испытывает игрок при подключении к регионам Amazon Web Services.
(структура)
Региональная информация о задержке для игрока, используемая при запросе новой игровой сессии. Это значение указывает на величину задержки, которая существует при подключении игрока к флоту в указанном регионе. Относительное различие между значениями задержки игрока для нескольких регионов используется для определения того, какие флоты лучше всего подходят для размещения новой игровой сессии для игрока.
PlayerId -> (строка)
RegionIdentifier -> (строка)
LatencyInMilliseconds -> (вещественное число)
StartTime -> (временная метка)
"1469498468.057" ).EndTime -> (временная метка)
IpAddress -> (строка)
FULFILLED .DnsName -> (строка)
Идентификатор DNS, назначенный экземпляру, на котором выполняется игровая сессия. Значения имеют следующий формат:
- Флоты с поддержкой TLS:
<unique identifier>.<region identifier>.amazongamelift.com. - Флоты без поддержки TLS:
ec2-<unique identifier>.compute.amazonaws.com. (См. Amazon EC2 Instance IP Addressing .)
При подключении к игровой сессии, выполняющейся на флоте с поддержкой TLS, необходимо использовать имя DNS, а не IP-адрес.
Port -> (целое число)
FULFILLED .PlacedPlayerSessions -> (список)
Коллекция информации о сессиях игроков, созданных в ответ на запрос на размещение игровой сессии. Эти сессии игроков создаются только после успешного размещения новой игровой сессии (статус размещения FULFILLED ). Эта информация включает идентификатор игрока, предоставленный в запросе на размещение, и соответствующий идентификатор сессии игрока.
(структура)
Информация о сессии игрока. Этот объект содержит только идентификатор игрока и идентификатор сессии игрока. Для получения подробной информации о сессии игрока выполните вызов DescribePlayerSessions с идентификатором сессии игрока.
PlayerId -> (строка)
PlayerSessionId -> (строка)
GameSessionData -> (строка)
MatchmakerData -> (строка)
PriorityConfigurationOverride -> (структура)
Альтернативный список приоритетов местоположений, включенный в запрос на размещение игровой сессии. При наличии он переопределяет список порядка расположения мест в очереди только для этого запроса на размещение игровой сессии. Список может включать регионы Amazon Web Services, локальные зоны и настраиваемые местоположения (для флотов Anywhere). Стратегия резервного копирования сообщает Amazon GameLift, какое действие предпринять (если таковое имеется), если ему не удалось разместить новую игровой сессии.
PlacementFallbackStrategy -> (строка)
Инструкции о том, как действовать в случае неудачи размещения во всех местоположениях в списке приоритетного переопределения. Допустимые стратегии включают:
-
DEFAULT_AFTER_SINGLE_PASS– После попытки разместить новую игровой сессию во всех местоположениях в списке приоритетного переопределения, попробуйте разместить игровую сессию в других местоположениях очереди. Это поведение по умолчанию. -
NONE– Ограничить размещение только местоположениями в списке приоритетного переопределения.
LocationOrder -> (список)
Упорядоченный список местоположений размещения. Список может содержать регионы Amazon Web Services (например, us-west-2 ), локальные зоны и настраиваемые местоположения (для флотов Anywhere). Каждое местоположение должно быть указано только один раз. Подробности см. в Amazon GameLift service locations.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.