Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

list-container-group-definitions

Описание

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

Данная операция возвращает только последнюю версию каждого определения. Чтобы получить все версии определения группы контейнеров, используйте ListContainerGroupDefinitionVersions .

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

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

Примечание

Данная операция возвращает список определений групп контейнеров без определенного порядка.

См. также: AWS API Documentation

list-container-group-definitions является постраничной операцией. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ContainerGroupDefinitions

Синтаксис

  list-container-group-definitions
[--container-group-type <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--container-group-type (строка)

Тип группы контейнеров для получения. Тип группы контейнеров определяет, как Amazon GameLift разворачивает группу контейнеров на каждом экземпляре флекса.

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

  • GAME_SERVER
  • PER_INSTANCE

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, значения этих аргументов переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Маркер для указания начала постраничной обработки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS Command Line Interface.

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

Вывод

ContainerGroupDefinitions -> (список)

Результат набора определений групп контейнеров, соответствующих запросу.

(структура)

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

Используется с: CreateContainerGroupDefinition

Возвращается: DescribeContainerGroupDefinition , ListContainerGroupDefinitions , UpdateContainerGroupDefinition

ContainerGroupDefinitionArn -> (строка)

Amazon Resource Name (ARN) — уникальный идентификатор ресурса Amazon GameLift во всех регионах Amazon Web Services. Формат — arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version] .

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

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

OperatingSystem -> (строка)

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

Примечание

Поддержка Amazon Linux 2 (AL2) закончится 30 июня 2025 года. Более подробную информацию см. в разделе FAQ по Amazon Linux 2. Для игровых серверов, размещенных на AL2 и использующих версию серверного SDK 4.x для Amazon GameLift, сначала обновите сборку игрового сервера на серверный SDK 5.x, а затем разверните на экземплярах AL2023. См. Раздел «Миграция на версию серверного SDK 5».

Name -> (строка)

Описание идентификатора для определения группы контейнеров. Значение имени уникально в регионе Amazon Web Services.

ContainerGroupType -> (строка)

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

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

Объем памяти (в МБ) на экземпляре флекса, выделяемый для группы контейнеров. Все контейнеры в группе делят эти ресурсы.

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

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

Объем единиц vCPU на экземпляре флекса, выделяемых для группы контейнеров (1 vCPU равен 1024 единицам CPU). Все контейнеры в группе делят эти ресурсы. Вы можете установить предел для каждого определения контейнера в группе. Если для отдельных контейнеров установлены пределы, это общее значение должно быть равно или больше суммы пределов для каждого контейнера в группе.

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

Определение контейнера игрового сервера в этой группе. Это свойство используется только тогда, когда тип группы контейнеров — GAME_SERVER . Это определение контейнера указывает образ контейнера со сборкой игрового сервера.

ContainerName -> (строка)

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

DependsOn -> (список)

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

(структура)

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

Например, ContainerA настроен со следующей зависимостью: зависимость START от ContainerB . Это означает, что ContainerA не может начать работу, пока ContainerB не запустится. Это также означает, что ContainerA должен завершить работу до ContainerB .

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

ContainerName -> (строка)

Описательная метка для определения контейнера, от которого зависит этот контейнер.

Condition -> (строка)

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

  • START - Контейнер-зависимость должен быть запущен.
  • COMPLETE - Контейнер-зависимость завершил работу (выход).
  • SUCCESS - Контейнер-зависимость завершил работу с нулевым статусом. Контейнер-зависимость не может быть важным контейнером.
  • HEALTHY - Контейнер-зависимость прошёл проверку работоспособности Docker. Используйте это условие с контейнерами-зависимостями, у которых настроены проверки работоспособности. Это условие проверяется только при запуске группы контейнеров.

MountPoints -> (список)

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

(структура)

Точка монтирования, которая связывает контейнер с файлом или каталогом на хост-системе.

Часть от: GameServerContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html , SupportContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html

InstancePath -> (строка)

Путь к исходному файлу или каталогу.

ContainerPath -> (строка)

Путь монтирования в контейнере. Если это свойство не задано, используется путь экземпляра.

AccessLevel -> (строка)

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

EnvironmentOverride -> (список)

Набор переменных среды, передаваемых контейнеру при запуске. См. параметр ContainerDefinition::environment в «Справочнике по API Amazon Elastic Container Service».

(структура)

Переменная среды, задаваемая внутри контейнера в виде пары ключ-значение.

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

Name -> (строка)

Имя переменной среды.

Value -> (строка)

Значение переменной среды.

ImageUri -> (строка)

URI образа, используемого Amazon GameLift при развертывании этого контейнера в флекс-парке контейнеров. Для более специфичного идентификатора см. ResolvedImageDigest .

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

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

ContainerPortRanges -> (список)

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

(структура)

Набор одного или нескольких номеров портов, которые можно открыть в контейнере.

Часть от: ContainerPortConfiguration

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

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

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

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

Protocol -> (строка)

Сеть протокол, который поддерживают эти порты.

ResolvedImageDigest -> (строка)

Уникальный и неизменяемый идентификатор образа контейнера. Хэш — SHA 256 образа манифеста контейнера.

ServerSdkVersion -> (строка)

Версия серверного SDK Amazon GameLift, с которой интегрирован игровой сервер. Только игровые серверы, использующие версию 5.2.0 или выше, совместимы с флекс-парками контейнеров.

SupportContainerDefinitions -> (список)

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

(структура)

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

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

Часть от: ContainerGroupDefinition

Возвращается: DescribeContainerGroupDefinition , ListContainerGroupDefinitions , UpdateContainerGroupDefinition

ContainerName -> (строка)

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

DependsOn -> (список)

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

(структура)

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

Например, ContainerA настроен со следующей зависимостью: START зависимость от ContainerB . Это означает, что ContainerA не может начаться, пока ContainerB не запустится. Это также означает, что ContainerA должен завершить работу до ContainerB .

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

ContainerName -> (строка)

Дескриптивная метка для определения контейнера, от которого зависит этот контейнер.

Condition -> (строка)

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

  • START - Зависимый контейнер должен быть запущен.
  • COMPLETE - Зависимый контейнер завершил работу (выход). Используйте это условие для некритичных контейнеров, таких как те, которые выполняют скрипт и затем завершаются. Зависимый контейнер не может быть критическим контейнером.
  • SUCCESS - Зависимый контейнер завершил работу и вышел с нулевым статусом. Зависимый контейнер не может быть критическим контейнером.
  • HEALTHY - Зависимый контейнер прошёл проверку работоспособности Docker. Используйте это условие для зависимых контейнеров, у которых настроены проверки работоспособности. Это условие проверяется только при запуске группы контейнеров.

MountPoints -> (список)

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

(структура)

Точка монтирования, которая связывает контейнер с файлом или каталогом на хост-системе.

Часть от: GameServerContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html , SupportContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html

InstancePath -> (строка)

Путь к исходному файлу или каталогу.

ContainerPath -> (строка)

Путь монтирования в контейнере. Если это свойство не задано, используется путь экземпляра.

AccessLevel -> (строка)

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

EnvironmentOverride -> (список)

Набор переменных среды, передаваемых контейнеру при запуске. См. параметр ContainerDefinition::environment в Amazon Elastic Container Service API Reference .

(структура)

Переменная среды для установки внутри контейнера в формате пары «ключ-значение».

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

Name -> (строка)

Имя переменной среды.

Value -> (строка)

Значение переменной среды.

Essential -> (булево)

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

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

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

Command -> (список)

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

(строка)

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

Период времени (в секундах) между каждой проверкой работоспособности.

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

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

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

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

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

Период времени (в секундах), в течение которого ожидать успешного завершения проверки работоспособности перед подсчётом неудачной проверки работоспособности.

ImageUri -> (строка)

URI образа, который Amazon GameLift развертывает во флот контейнеров. Для более конкретного идентификатора см. ResolvedImageDigest .

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

Объем памяти, предоставляемый Amazon GameLift контейнеру. Если для отдельных контейнеров не установлены лимиты памяти, контейнер разделяет общее выделение памяти группы контейнеров.

Связанный тип данных: ContainerGroupDefinition TotalMemoryLimitMebibytes

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

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

ContainerPortRanges -> (список)

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

(структура)

Набор одного или нескольких номеров портов, которые могут быть открыты в контейнере.

Часть от: ContainerPortConfiguration

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

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

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

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

Protocol -> (строка)

Сеть протокол, поддерживаемый этими портами.

ResolvedImageDigest -> (строка)

Уникальный и неизменяемый идентификатор образа контейнера. Digest — это хэш SHA 256 манифеста образа контейнера.

Vcpu -> (двойное число)

Количество единиц vCPU, зарезервированных для контейнера. Если ресурсы не зарезервированы, контейнер разделяет общий лимит vCPU для группы контейнеров.

Связанный тип данных: ContainerGroupDefinition TotalVcpuLimit

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

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

VersionDescription -> (строка)

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

Status -> (строка)

Текущее состояние ресурса определения группы контейнеров. Значения включают:

  • COPYING – Amazon GameLift в процессе создания копий всех образов контейнеров, определённых в группе. В этом состоянии ресурс нельзя использовать для создания флота контейнеров.
  • READY – Amazon GameLift скопировал образы реестра для всех контейнеров, определённых в группе. Вы можете использовать определение группы контейнеров в этом состоянии для создания флота контейнеров.
  • FAILED – Amazon GameLift не смог создать допустимый ресурс определения группы контейнеров. Для получения более подробной информации о причине ошибки см. StatusReason . Ресурс определения группы контейнеров в состоянии ошибки будет удалён в течение нескольких минут.

StatusReason -> (строка)

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

  • Внутренняя проблема помешала Amazon GameLift создать ресурс определения группы контейнеров. Удалите проблемный ресурс и снова вызовите CreateContainerGroupDefinition.
  • Сообщение об отказе в доступе означает, что у вас нет разрешений на доступ к образу контейнера в ECR. Для получения помощи в настройке необходимых разрешений IAM для Amazon GameLift см. примеры разрешений IAM.
  • Значение ImageUri для хотя бы одного из контейнеров в определении группы контейнеров было недопустимым или не найдено в текущей учётной записи Amazon Web Services.
  • Хотя бы один из образов контейнеров, указанных в определении группы контейнеров, превышает разрешенный размер. Сведения о лимитах размера см. в Amazon GameLift узлы и квоты.
  • Хотя бы один из образов контейнеров, указанных в определении группы контейнеров, использует операционную систему, отличную от определённой для группы контейнеров.

NextToken -> (строка)

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

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

Spec-Zone.ru

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