Spec-Zone.ru › AWS CLI v2

[ aws . elasticbeanstalk ]

describe-environments

Описание

Возвращает описания существующих сред.

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

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

Синтаксис

  describe-environments
[--application-name <value>]
[--version-label <value>]
[--environment-ids <value>]
[--environment-names <value>]
[--include-deleted | --no-include-deleted]
[--included-deleted-back-to <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]

Параметры

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

Если указано, AWS Elastic Beanstalk ограничивает возвращаемые описания только теми, которые связаны с этим приложением.

--version-label (строка)

Если указано, AWS Elastic Beanstalk ограничивает возвращаемые описания только теми, которые связаны с этой версией приложения.

--environment-ids (список)

Если указано, AWS Elastic Beanstalk ограничивает возвращаемые описания только теми, которые имеют указанные идентификаторы.

(строка)

Синтаксис:

"string" "string" ...

--environment-names (список)

Если указано, AWS Elastic Beanstalk ограничивает возвращаемые описания только теми, которые имеют указанные имена.

(строка)

Синтаксис:

"string" "string" ...

--include-deleted | --no-include-deleted (булево)

Указывает, включать ли удаленные среды:

true : Отображаются среды, удаленные после IncludedDeletedBackTo.

false : Удаленные среды не включаются.

--included-deleted-back-to (метка времени)

Если указано, когда IncludeDeleted установлено в true, отображаются среды, удаленные после этой даты.

--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
  • text
  • таблица
  • 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Чтобы просмотреть информацию об окружении

Следующая команда извлекает информацию об окружении с именем my-env:

aws elasticbeanstalk describe-environments --environment-names my-env

Вывод:

{
    "Environments": [
        {
            "ApplicationName": "my-app",
            "EnvironmentName": "my-env",
            "VersionLabel": "7f58-stage-150812_025409",
            "Status": "Ready",
            "EnvironmentId": "e-rpqsewtp2j",
            "EndpointURL": "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com",
            "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
            "CNAME": "my-env.elasticbeanstalk.com",
            "Health": "Green",
            "AbortableOperationInProgress": false,
            "Tier": {
                "Version": " ",
                "Type": "Standard",
                "Name": "WebServer"
            },
            "DateUpdated": "2015-08-12T18:16:55.019Z",
            "DateCreated": "2015-08-07T20:48:49.599Z"
        }
    ]
}

Выходные данные

Среды -> (список)

Возвращает список описаний сред.

(структура)

Описывает свойства среды.

ИмяСреды -> (строка)

Название этой среды.

ИдентификаторСреды -> (строка)

Идентификатор этой среды.

НазваниеПриложения -> (строка)

Название приложения, связанного с этой средой.

МеткаВерсии -> (строка)

Версия приложения, развернутая в этой среде.

НазваниеСтекаРешений -> (строка)

Название SolutionStack, развернутого с этой средой.

ArnПлатформы -> (строка)

ARN версии платформы.

ИмяШаблона -> (строка)

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

Описание -> (строка)

Описание этой среды.

URL_точки_доступа -> (строка)

Для сред с балансировкой нагрузки и автоматическим масштабированием — URL балансировщика нагрузки. Для сред с единственным экземпляром — IP-адрес экземпляра.

CNAME -> (строка)

URL CNAME для этой среды.

ДатаСоздание -> (временная_метка)

Дата создания этой среды.

ДатаОбновления -> (временная_метка)

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

Статус -> (строка)

Текущий рабочий статус среды:

  • Launching : Среда находится в процессе первоначального развертывания.
  • Updating : Среда находится в процессе обновления настроек конфигурации или версии приложения.
  • Ready : Среда доступна для выполнения действий, таких как обновление или завершение.
  • Terminating : Среда находится в процессе закрытия.
  • Terminated : Среда не запущена.

AbortableOperationInProgress -> (булево)

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

true: Обновление выполняется.

false: В данный момент нет выполняемых обновлений.

Состояние -> (строка)

Описывает состояние работоспособности среды. AWS Elastic Beanstalk указывает уровни ошибок для работающей среды:

  • Red : Указывает, что среда не реагирует. Возникает, когда для среды происходит три или более последовательных сбоя.
  • Yellow : Указывает, что что-то не так. Возникает, когда для среды происходит два последовательных сбоя.
  • Green : Указывает, что среда работоспособна и полностью функциональна.
  • Grey : Стандартное состояние работоспособности новой среды. Среда не полностью запущена, проверки работоспособности не начались или проверки работоспособности приостановлены во время запроса UpdateEnvironment или RestartEnvironment.

По умолчанию: Grey

СостояниеРаботоспособности -> (строка)

Возвращает состояние работоспособности приложения, работающего в вашей среде. Дополнительную информацию см. в разделе Цвета и статусы работоспособности.

Ресурсы -> (структура)

Описание AWS-ресурсов, используемых этой средой.

БалансировщикНагрузки -> (структура)

Описывает балансировщик нагрузки.

НазваниеБалансировщикаНагрузки -> (строка)

Название балансировщика нагрузки.

Домен -> (строка)

Имя домена балансировщика нагрузки.

Слушатели -> (список)

Список слушателей, используемых балансировщиком нагрузки.

(структура)

Описывает свойства слушателя балансировщика нагрузки.

Протокол -> (строка)

Протокол, используемый слушателем.

Порт -> (целое)

Порт, используемый слушателем.

Уровень -> (структура)

Описывает текущий уровень этой среды.

Имя -> (строка)

Название уровня этой среды.

Допустимые значения:

  • Для уровня веб-сервера — WebServer
  • Для уровня рабочей среды — Worker

Тип -> (строка)

Тип этого уровня среды.

Допустимые значения:

  • Для уровня веб-сервера — Standard
  • Для уровня рабочей среды — SQS/HTTP

Версия -> (строка)

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

Примечание

Этот член устарел. Любая конкретная версия, которую вы устанавливаете, может устареть. Рекомендуется оставить ее не заданной.

СсылкиНаСреды -> (список)

Список ссылок на другие среды в той же группе.

(структура)

Ссылка на другую среду, определенная в манифесте среды. Ссылки предоставляют информацию о подключении в системных свойствах, которые могут использоваться для подключения к другой среде в той же группе. Подробности см. в разделе Манифест среды (env.yaml).

ИмяСсылки -> (строка)

Имя ссылки.

ИмяСреды -> (строка)

Название связанной среды (зависимости).

ArnСреды -> (строка)

Amazon Resource Name (ARN) среды, который можно использовать в других запросах API, требующих ARN.

РольОпераций -> (строка)

Amazon Resource Name (ARN) роли операций среды. Дополнительную информацию см. в разделе Роли операций в Руководстве разработчика AWS Elastic Beanstalk.

NextToken -> (строка)

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

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

Spec-Zone.ru

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