[ aws . gamelift ]

описание-определения-группы-контейнеров

Описание

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

Параметры запроса:

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

Результаты:

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

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

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

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

Синтаксис

  describe-container-group-definition
--name <value>
[--version-number <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]

Параметры

--name (строка)

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

--version-number (целое число)

Конкретная версия для получения.

--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-auto-prompt (логическое значение)

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

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

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

Вывод

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

Свойства запрашиваемого ресурса определения группы контейнеров.

ContainerGroupDefinitionArn -> (строка)

Идентификатор Amazon Resource Name (ARN) назначенный ресурсу Amazon GameLift ContainerGroupDefinition. Единственным образом идентифицирует ресурс по всем регионам 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 - Контейнер-зависимость завершен и завершен с нулевым статусом. Контейнер-зависимость не может быть основным контейнером.
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 -> (строка)

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

AccessLevel -> (строка)

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

EnvironmentOverride -> (список)

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

(структура)

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

Часть от: 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 для получения помощи в настройке необходимых разрешений IAM для Amazon GameLift.
Значение ImageUri для хотя бы одного из контейнеров в определении группы контейнеров было некорректным или не найдено в текущей учётной записи Amazon Web Services.
Хотя бы один из образов контейнеров, указанных в определении группы контейнеров, превышает разрешённый размер. Ограничения по размеру см. в документации по конечным точкам и квотам Amazon GameLift.
Хотя бы один из образов контейнеров, указанных в определении группы контейнеров, использует операционную систему, отличную от определённой для группы контейнеров.