Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

describe-container-fleet

Описание

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

Параметры запроса
  • Получение свойств контейнерного флота для одного флота. Укажите идентификатор или ARN флота.
Результаты

В случае успеха возвращается объект ContainerFleet. Этот объект включает свойства флота, включая информацию о последнем развертывании.

Примечание

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

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

Синтаксис

  describe-container-fleet
--fleet-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]

Параметры

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

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

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

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

Свойства запрошенного контейнерного флота, включая текущий статус.

FleetId -> (строка)

Уникальный идентификатор контейнерного флота для извлечения.

FleetArn -> (строка)

Идентификатор Amazon Resource Name (ARN), назначенный ресурсу флота Amazon GameLift и уникально его определяющий. ARNs уникальны во всех регионах. Формат — arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. В ARN флота GameLift идентификатор ресурса соответствует значению FleetId.

FleetRoleArn -> (строка)

Уникальный идентификатор роли управления доступом и идентификацией (IAM) с разрешениями для запуска ваших контейнеров на ресурсах, управляемых Amazon GameLift. См. Настройка службы IAM.

GameServerContainerGroupDefinitionName -> (строка)

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

GameServerContainerGroupDefinitionArn -> (строка)

Идентификатор Amazon Resource Name (ARN), назначенный группе контейнеров серверов игр флота. Значение ARN также определяет конкретную версию определения группы контейнеров, используемую в настоящее время.

PerInstanceContainerGroupDefinitionName -> (строка)

Имя определения группы контейнеров на экземпляр флота.

PerInstanceContainerGroupDefinitionArn -> (строка)

Идентификатор Amazon Resource Name (ARN), назначенный группе контейнеров на экземпляр флота. Значение ARN также определяет конкретную версию определения группы контейнеров, используемую в настоящее время.

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

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

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

Начальное значение диапазона портов.

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

Конечное значение диапазона. Номера портов включают конечные значения. Это значение должно быть равно или больше FromPort.

InstanceInboundPermissions -> (список)

Диапазоны IP-адресов и параметры портов, позволяющие входящему трафику получать доступ к процессам серверов игр и другим процессам в этом флоте.

(структура)

Диапазон IP-адресов и параметры портов, позволяющие входящему трафику подключаться к процессам на экземпляре в флоте. Процессам назначается комбинация IP-адрес/номер порта, которая должна входить в разрешенные диапазоны флота.

Для флотов Amazon GameLift Realtime Amazon GameLift автоматически открывает два диапазона портов, один для TCP-сообщений и один для UDP.

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

Начальное значение диапазона разрешенных номеров портов.

Для флотов, использующих сборки Linux, допустимы только порты 22 и 1026-60000.

Для флотов, использующих сборки Windows, допустимы только порты 1026-60000.

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

Конечное значение диапазона разрешенных номеров портов. Номера портов включают конечные значения. Это значение должно быть равно или больше FromPort.

Для флотов, использующих сборки Linux, допустимы только порты 22 и 1026-60000.

Для флотов, использующих сборки Windows, допустимы только порты 1026-60000.

IpRange -> (строка)

Диапазон разрешенных IP-адресов. Это значение должно быть выражено в нотации CIDR. Пример: “000.000.000.000/[subnet mask]” или, необязательно, сокращенная версия “0.0.0.0/[subnet mask]”.

Protocol -> (строка)

Сеть протокол, используемый флотом.

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

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

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

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

InstanceType -> (строка)

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

BillingType -> (строка)

Указывает, использует ли флот экземпляры On-Demand или Spot для этого флота. Узнайте больше о том, когда использовать экземпляры On-Demand и Spot. Вы не можете обновить это свойство флота.

По умолчанию это свойство установлено в значение ON_DEMAND.

Description -> (строка)

Определяющее описание контейнерного флота.

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

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

MetricGroups -> (список)

Имя группы метрик Amazon Web Services CloudWatch, к которой следует добавить этот флот. Группы метрик агрегируют метрики для нескольких флотов.

(строка)

NewGameSessionProtectionPolicy -> (строка)

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

  • NoProtection – Игровые сессии могут быть остановлены во время активной игры.
  • FullProtection – Игровые сессии в состоянии ACTIVE не могут быть остановлены.

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

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

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

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

Политика оценивается при попытке игрока создать новую игровую сессию. Получив запрос CreateGameSession, Amazon GameLift проверяет, что игрок (определяемый по значению CreatorId) создал меньше, чем лимит игровых сессий, в указанный период времени.

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

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

Status -> (строка)

Текущий статус контейнерного флота.

  • PENDING – Запрошен новый контейнерный флот.
  • CREATING – Создается новый ресурс контейнерного флота.
  • CREATED – Создан новый ресурс контейнерного флота. Экземпляры флота не развернуты.
  • ACTIVATING – Развертываются новые экземпляры контейнерного флота.
  • ACTIVE – Контейнерный флот развернут и готов принимать игровые сессии.
  • UPDATING – Обновления контейнерного флота обновляются. Развертывание в процессе.

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

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

LatestDeploymentId -> (строка)

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

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

Метод сбора журналов контейнеров для флота. Amazon GameLift сохраняет весь стандартный вывод для каждого контейнера в журналах, включая журналы игровых сессий.

  • CLOUDWATCH – Отправка журналов в группу журналов Amazon CloudWatch, которую вы определяете. Каждый контейнер генерирует поток журнала, который организован в группе журнала.
  • S3 – Сохранение журналов в ведре Amazon S3, которое вы определяете.
  • NONE – Не собирать журналы контейнеров.

LogDestination -> (строка)

Тип сбора журналов для использования в флоте.

  • CLOUDWATCH – (значение по умолчанию) Отправка журналов в группу журналов Amazon CloudWatch, которую вы определяете. Каждый контейнер генерирует поток журнала, который организован в группе журнала.
  • S3 – Сохранение журналов в ведре Amazon S3, которое вы определяете. Это ведро должно находиться в родном регионе Amazon Web Services флота.
  • NONE – Не собирать журналы контейнеров.

S3BucketName -> (строка)

Если место назначения журнала — S3, журналы отправляются в указанное имя ведра Amazon S3.

LogGroupArn -> (строка)

Если место назначения журнала — CLOUDWATCH, журналы отправляются в указанную группу журнала в Amazon CloudWatch.

LocationAttributes -> (список)

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

(структура)

Подробности о местоположении в контейнерном флоте с несколькими местоположениями.

Location -> (строка)

Идентификатор местоположения.

Status -> (строка)

Статус активности флота в местоположении.

  • PENDING – Запрошен новый контейнерный флот.
  • CREATING – Создается новый ресурс контейнерного флота.
  • CREATED – Создан новый ресурс контейнерного флота. Экземпляры флота не развернуты.
  • ACTIVATING – Развертываются новые экземпляры контейнерного флота.
  • ACTIVE – Контейнерный флот развернут и готов принимать игровые сессии.
  • UPDATING – Обновления контейнерного флота обновляются. Развертывание в процессе.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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