Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

получение развертываний службы контейнеров

Описание

Возвращает развертывания для вашей службы контейнеров Amazon Lightsail.

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

Развертывания упорядочены по версии в порядке возрастания. Самая новая версия указана вверху ответа.

Примечание

Определённое количество развертываний сохраняется, прежде чем самое старое заменяется самым новым. Дополнительную информацию можно найти в разделе «Конечные точки и квоты Amazon Lightsail» в Справочнике Amazon Web Services.

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

Синтаксис

  get-container-service-deployments
--service-name <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]

Параметры

--service-name (строка)

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

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

Вывод

deployments -> (список)

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

(структура)

Описывает конфигурацию развертывания контейнера для службы контейнеров Amazon Lightsail.

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

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

Номер версии развертывания.

state -> (строка)

Состояние развертывания.

Развертывание может находиться в одном из следующих состояний:

  • ACTIVATING - Развертывание создаётся.
  • ACTIVE - Развертывание успешно создано и в настоящее время работает в службе контейнеров. В службе контейнеров может быть только одно развертывание в активном состоянии одновременно.
  • INACTIVE - Развертывание было успешно создано ранее, но в настоящее время не работает в службе контейнеров.
  • FAILED - Развертывание завершилось неудачно. Используйте действие GetContainerLog, чтобы просмотреть журналы событий контейнеров в развертывании и попытаться определить причину неудачи.

containers -> (словарь)

Объект, описывающий конфигурацию контейнеров развертывания.

key -> (строка)

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

Описывает параметры контейнера, который будет запущен или запущен в службе контейнеров Amazon Lightsail.

image -> (строка)

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

Изображения контейнеров, полученные из вашей службы контейнеров Lightsail, зарегистрированные и сохранённые в вашей службе, начинаются с двоеточия (:). Например, если имя вашей службы контейнеров – container-service-1, метка изображения контейнера – mystaticsite, и вы хотите использовать третью (3) версию зарегистрированного изображения контейнера, то вы должны указать :container-service-1.mystaticsite.3. Чтобы использовать последнюю версию изображения контейнера, укажите latest вместо номера версии (например, :container-service-1.mystaticsite.latest). Lightsail автоматически использует версию зарегистрированного изображения контейнера с наибольшим номером.

Изображения контейнеров, полученные из общедоступного реестра, такого как Docker Hub, не начинаются с двоеточия. Например, nginx:latest или nginx.

command -> (список)

Команда запуска для контейнера.

(строка)

environment -> (словарь)

Переменные среды контейнера.

key -> (строка)

value -> (строка)

ports -> (словарь)

Открытые порты брандмауэра контейнера.

key -> (строка)

value -> (строка)

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

Объект, описывающий конечную точку развертывания.

containerName -> (строка)

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

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

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

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

Объект, описывающий конфигурацию проверки состояния контейнера.

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

Количество последовательных успешных проверок состояния, необходимых для перевода контейнера в состояние Healthy. Значение по умолчанию – 2.

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

Количество последовательных неудач проверки состояния, необходимых для перевода контейнера в состояние Unhealthy. Значение по умолчанию – 2.

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

Время в секундах, в течение которого отсутствие ответа означает неудачную проверку состояния. Можно указать значения от 2 до 60 секунд. Значение по умолчанию – 2.

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

Приблизительный интервал в секундах между проверками состояния отдельных контейнеров. Можно указать значения от 5 до 300 секунд. Значение по умолчанию – 5.

path -> (строка)

Путь в контейнере, на котором выполняется проверка состояния. Значение по умолчанию – /.

successCodes -> (строка)

HTTP-коды, используемые при проверке успешного ответа от контейнера. Можно указать значения от 200 до 499. Можно указать несколько значений (например, 200,202) или диапазон значений (например, 200-299).

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

Временная метка создания развертывания.

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

Spec-Zone.ru

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