Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

describe-matchmaking

Описание

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

Для запроса билетов на подбор игроков укажите список из не более чем 10 идентификаторов билетов. При успешном запросе для каждого существующего идентификатора билета, который был запрошен, возвращается объект билета.

Эта операция не предназначена для постоянного вызова для отслеживания состояния билетов на подбор игроков. Такое поведение может привести к превышению лимита API, что вызывает ошибки. Вместо этого, рекомендуется настроить Amazon Simple Notification Service для получения уведомлений и указать тему ARN в конфигурации подбора.

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

Добавление FlexMatch в клиент игры

Настройка уведомлений о событиях FlexMatch

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

Синтаксис

  describe-matchmaking
--ticket-ids <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]

Параметры

--ticket-ids (список)

Уникальный идентификатор билета на подбор игроков. Вы можете указать до 10 значений идентификаторов.

(строка)

Синтаксис:

"string" "string" ...

--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-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запрошение параметров ввода CLI.

Вывод

TicketList -> (список)

Коллекция существующих объектов билета сопоставления, соответствующих запросу.

(структура)

Билет, созданный для отслеживания хода запроса сопоставления. Каждый билет уникально идентифицируется идентификатором билета, предоставленным запросом при создании запроса сопоставления.

TicketId -> (строка)

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

ConfigurationName -> (строка)

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

ConfigurationArn -> (строка)

Идентификатор ресурса Amazon (ARN), связанный с ресурсом конфигурации сопоставления GameLift, который используется с этим билетом.

Status -> (строка)

Текущий статус запроса сопоставления.

  • ОЧЕРЕДЬ – Запрос на сопоставление получен и в настоящее время ожидает обработки.
  • ПОИСК – Запрос на сопоставление в настоящее время обрабатывается.
  • ТРЕБУЕТСЯ_ПРИНЯТИЕ – Предложен матч, и игроки должны принять его. Этот статус используется только для запросов, которые используют конфигурацию сопоставления с требованием принятия игрока.
  • РАЗМЕЩЕНИЕ – Движок FlexMatch сопоставил игроков и в настоящее время размещает новую игровую сессию для матча.
  • ЗАВЕРШЕНО – Игроки сопоставлены, и игровая сессия готова принять игроков. Билет в этом состоянии содержит необходимую информацию о подключении для игроков.
  • НЕУДАЧА – Запрос на сопоставление не был завершен.
  • ОТМЕНЕНО – Запрос сопоставления был отменен. Это может быть результатом операции StopMatchmaking или предложенного матча, который один или несколько игроков не смогли принять.
  • ИСТЕКЛО_ВРЕМЯ – Запрос сопоставления не был успешным в течение указанного в конфигурации сопоставления времени.

Примечание

Запросы сопоставления, которые не завершились успешно (статусы НЕУДАЧА, ОТМЕНЕНО, ИСТЕКЛО_ВРЕМЯ), могут быть повторно отправлены как новые запросы с новыми идентификаторами билетов.

StatusReason -> (строка)

Код, объясняющий текущий статус. Например, причина статуса может указывать, когда билет вернулся в статус SEARCHING после того, как предложенный матч не получил принятия игрока.

StatusMessage -> (строка)

Дополнительная информация о текущем статусе.

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

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

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

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

Players -> (список)

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

(структура)

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

PlayerId -> (строка)

Уникальный идентификатор игрока

PlayerAttributes -> (карта)

Коллекция пар «ключ:значение», содержащая информацию об игроке для использования в процессе сопоставления. Ключи атрибутов игрока должны совпадать с ключами playerAttributes, используемыми в наборе правил сопоставления. Пример: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

Вы можете предоставить до 10 PlayerAttributes.

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

значение -> (структура)

Значения для использования в парах «ключ:значение» атрибутов игрока. Этот объект позволяет вам указать значение атрибута, используя любой из допустимых типов данных: строка, число, массив строк или карта данных. Каждый объект AttributeValue может использовать только одну из доступных свойств.

S -> (строка)

Для одиночных строковых значений. Максимальная длина строки составляет 100 символов.

N -> (двойное)

Для числовых значений, выраженных как двойное.

SL -> (список)

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

(строка)

SDM -> (карта)

Для карты до 10 пар «тип данных:значение». Максимальная длина каждого строкового значения составляет 100 символов.

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

значение -> (двойное)

Team -> (строка)

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

LatencyInMs -> (карта)

Набор значений, выраженных в миллисекундах, которые указывают количество задержки, испытываемой игроком при подключении к регионам Amazon Web Services. Если это свойство присутствует, FlexMatch рассматривает размещение матча только в регионах, для которых сообщается задержка.

Если у сопоставителя есть правило, которое оценивает задержку игрока, игроки должны сообщить о задержке, чтобы быть сопоставленными. Если в этом случае задержка не сообщается, FlexMatch предполагает, что регионы недоступны для игрока, и билет не подлежит сопоставлению.

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

значение -> (целое число)

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

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

GameSessionArn -> (строка)

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

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-адрес.

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

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

MatchedPlayerSessions -> (список)

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

(структура)

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

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

PlayerId -> (строка)

Уникальный идентификатор игрока

PlayerSessionId -> (строка)

Уникальный идентификатор сессии игрока

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

Среднее время (в секундах), которое игроки в настоящее время ожидают матча. Если нет достаточных данных, это свойство может быть пустым.

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

Spec-Zone.ru

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