Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

получить-услуги-контейнеров

Описание

Возвращает информацию об одной или нескольких ваших услугах Amazon Lightsail для контейнеров.

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

Синтаксис

  get-container-services
[--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 (строка)

Имя службы контейнеров, для которой требуется информация.

Если параметр опущен, в ответе будут указаны все ваши службы контейнеров в регионе Amazon Web Services, в котором выполняется запрос.

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

Вывод

containerServices -> (список)

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

(структура)

Описывает Amazon Lightsail контейнерный сервис.

containerServiceName -> (строка)

Название контейнерного сервиса.

arn -> (строка)

Amazon Resource Name (ARN) контейнерного сервиса.

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

Метка времени создания контейнерного сервиса.

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

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

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимо).

regionName -> (строка)

Название региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса Lightsail контейнерного сервиса.

tags -> (список)

Ключи тегов и необязательные значения для ресурса. Более подробную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

(структура)

Описывает ключ тега и необязательное значение, назначенное Amazon Lightsail ресурсу.

Более подробную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

key -> (строка)

Ключ тега.

Ограничения: Ключи тегов принимают максимум 128 символов, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

value -> (строка)

Значение тега.

Ограничения: Значения тегов принимают максимум 256 символов, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

power -> (строка)

Спецификация мощности контейнерного сервиса.

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

powerId -> (строка)

Идентификатор мощности контейнерного сервиса.

state -> (строка)

Текущее состояние контейнерного сервиса.

Возможные состояния контейнерного сервиса:

  • PENDING - Контейнерный сервис создается.
  • READY - Контейнерный сервис работает, но у него нет активного развертывания контейнеров.
  • DEPLOYING - Контейнерный сервис запускает развертывание контейнеров.
  • RUNNING - Контейнерный сервис работает и имеет активное развертывание контейнеров.
  • UPDATING - Емкость контейнерного сервиса или его пользовательские домены обновляются.
  • DELETING - Контейнерный сервис удаляется.
  • DISABLED - Контейнерный сервис отключен, и его активное развертывание и контейнеры, если таковые имеются, остановлены.

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

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

Примечание

Детали состояния заполняются только тогда, когда контейнерный сервис находится в состоянии PENDING , DEPLOYING или UPDATING.

code -> (строка)

Код состояния контейнерного сервиса.

Возможные коды состояний:

  • Следующие коды состояний возможны, если ваш контейнерный сервис находится в состоянии DEPLOYING или UPDATING:
    • CREATING_SYSTEM_RESOURCES - Системные ресурсы вашего контейнерного сервиса создаются.
    • CREATING_NETWORK_INFRASTRUCTURE - Сеть вашего контейнерного сервиса создается.
    • PROVISIONING_CERTIFICATE - Сертификат SSL/TLS для вашего контейнерного сервиса создается.
    • PROVISIONING_SERVICE - Ваш контейнерный сервис настраивается.
    • CREATING_DEPLOYMENT - Развертывание создается на вашем контейнерном сервисе.
    • EVALUATING_HEALTH_CHECK - Оценивается состояние вашего развертывания.
    • ACTIVATING_DEPLOYMENT - Ваше развертывание активируется.
  • Следующие коды состояний возможны, если ваш контейнерный сервис находится в состоянии PENDING:
    • CERTIFICATE_LIMIT_EXCEEDED - Сертификат SSL/TLS, необходимый для вашего контейнерного сервиса, превышает максимальное количество сертификатов, разрешенных для вашей учетной записи.
    • UNKNOWN_ERROR - При создании контейнерного сервиса произошла ошибка.

message -> (строка)

Сообщение, предоставляющее дополнительную информацию для кода состояния.

Примечание

Детали состояния заполняются только тогда, когда контейнерный сервис находится в состоянии PENDING , DEPLOYING или UPDATING.

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

Спецификация масштабирования контейнерного сервиса.

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

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

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

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 -> (метка времени)

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

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

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

Это значение равно null, когда развертывания в состоянии pending нет.

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

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

state -> (строка)

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

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

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

containers -> (карта)

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

ключ -> (строка)

значение -> (структура)

Описывает настройки контейнера, который будет запущен или запущен в службе 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 -> (карта)

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

ключ -> (строка)

значение -> (строка)

ports -> (карта)

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

ключ -> (строка)

значение -> (строка)

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 -> (метка времени)

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

isDisabled -> (булево)

Булево значение, указывающее, отключена ли служба контейнеров.

principalArn -> (строка)

ARN принципала службы контейнеров.

ARN принципала может использоваться для создания отношений доверия между вашей стандартной учетной записью Amazon Web Services и вашей службой контейнеров Lightsail. Это позволяет предоставить вашей службе разрешение на доступ к ресурсам в вашей стандартной учетной записи Amazon Web Services.

privateDomainName -> (строка)

Приватное доменное имя службы контейнеров.

Приватное доменное имя доступно только другим ресурсам внутри виртуальной частной сети (VPC) по умолчанию вашей учетной записи Lightsail.

publicDomainNames -> (карта)

Общедоступное доменное имя службы контейнеров, например example.com и www.example.com.

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

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

Предупреждение

Необходимо создать и проверить сертификат SSL/TLS, прежде чем использовать общедоступные доменные имена со службой контейнеров. Используйте действие CreateCertificate для создания сертификата для общедоступных доменных имен, которые вы хотите использовать со службой контейнеров.

См. CreateContainerService или UpdateContainerService для получения информации о том, как указать общедоступные доменные имена для вашей службы контейнеров Lightsail.

ключ -> (строка)

значение -> (список)

(строка)

url -> (строка)

Общедоступный URL-адрес службы контейнеров.

Если общедоступная конечная точка не указана в currentDeployment, этот URL возвращает ответ 404.

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

Объект, описывающий конфигурацию службы контейнеров для доступа к частным репозиториям изображений контейнеров, таким как частные репозитории Amazon Elastic Container Registry (Amazon ECR).

Дополнительную информацию см. в разделе «Настройка доступа к частному репозиторию Amazon ECR для службы Amazon Lightsail контейнеров» в Руководстве разработчика Amazon Lightsail.

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

Объект, описывающий состояние активации роли, которую можно использовать для предоставления службе Lightsail контейнеров доступа к частным репозиториям Amazon ECR. Если роль активирована, также отображается Amazon Resource Name (ARN) роли.

isActive -> (булево)

Булево значение, указывающее, активирована ли роль.

principalArn -> (строка)

Amazon Resource Name (ARN) роли, если она активирована.

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

Spec-Zone.ru

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