Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

list-container-group-definition-versions

Описание

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

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

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

Примечание

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

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

  • Управление определением группы контейнеров

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

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

Синопсис

  list-container-group-definition-versions
--name <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]

Параметры

--name (строка)

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

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, которое соответствует двоичному блоку, 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 года. Более подробную информацию см. в часто задаваемых вопросах по 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 процессорным единицам). Все контейнеры в группе совместно используют эти ресурсы. Вы можете установить ограничение для каждого контейнера в группе. Если у отдельных контейнеров есть ограничения, это общее значение должно быть равно или больше суммы ограничений для каждого контейнера в группе.

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

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

ContainerName -> (строка)

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

DependsOn -> (список)

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

(структура)

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

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

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

ContainerName -> (строка)

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

Condition -> (строка)

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

  • START - Контейнер-зависимость должен быть запущен.
  • COMPLETE - Контейнер-зависимость выполнен до завершения (выход).
  • SUCCESS - Контейнер-зависимость выполнен до завершения и завершился со статусом 0. Контейнер-зависимость не может быть контейнером-необходимым элементом.
  • 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 -> (строка)

Уникальный и неизменяемый идентификатор контейнерного образа. Digest — это хэш 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