Spec-Zone.ru › AWS CLI v2

[ aws . autoscaling ]

describe-warm-pool

Описание

Получает информацию о тёплом пуле и его экземплярах.

Для получения дополнительной информации, см. раздел «Тёплые пулы для Amazon EC2 Auto Scaling» в руководстве пользователя Amazon EC2 Auto Scaling.

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

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

Синтаксис

  describe-warm-pool
--auto-scaling-group-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]

Параметры

--auto-scaling-group-name (строка)

Имя группы Auto Scaling.

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

Примеры

Примечание

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

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

Для описания тёплого пула

В данном примере описывается тёплый пул для указанной группы Auto Scaling.

aws autoscaling describe-warm-pool \
    --auto-scaling-group-name my-asg

Вывод:

{
    "WarmPoolConfiguration": {
        "MinSize": 2,
        "PoolState": "Stopped"
    },
    "Instances": [
        {
            "InstanceId": "i-070a5bbc7e7f40dc5",
            "InstanceType": "t2.micro",
            "AvailabilityZone": "us-west-2c",
            "LifecycleState": "Warmed:Pending",
            "HealthStatus": "Healthy",
            "LaunchTemplate": {
                "LaunchTemplateId": "lt-00a731f6e9fa48610",
                "LaunchTemplateName": "my-template-for-auto-scaling",
                "Version": "6"
            }
        },
        {
            "InstanceId": "i-0b52f061814d3bd2d",
            "InstanceType": "t2.micro",
            "AvailabilityZone": "us-west-2b",
            "LifecycleState": "Warmed:Pending",
            "HealthStatus": "Healthy",
            "LaunchTemplate": {
                "LaunchTemplateId": "lt-00a731f6e9fa48610",
                "LaunchTemplateName": "my-template-for-auto-scaling",
                "Version": "6"
            }
        }
    ]
}

Для получения дополнительной информации, см. раздел «Тёплые пулы для Amazon EC2 Auto Scaling» в руководстве пользователя Amazon EC2 Auto Scaling.

Вывод

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

Подробная информация о конфигурации тёплого пула.

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

Максимальное количество экземпляров, которые разрешено содержать в тёплом пуле или в любом состоянии, кроме Terminated для группы Auto Scaling.

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

Минимальное количество экземпляров для поддержания в тёплом пуле.

PoolState -> (строка)

Состояние экземпляра, в которое будет произведена смена после завершения действий жизненного цикла.

Status -> (строка)

Состояние тёплого пула, помеченного на удаление.

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

Политика повторного использования экземпляров.

ReuseOnScaleIn -> (логическое значение)

Указывает, можно ли возвращать экземпляры в группу Auto Scaling в тёплый пул при уменьшении масштаба.

Instances -> (список)

Экземпляры, которые в данный момент находятся в тёплом пуле.

(структура)

Описание экземпляра EC2.

InstanceId -> (строка)

Идентификатор экземпляра.

InstanceType -> (строка)

Тип экземпляра EC2.

AvailabilityZone -> (строка)

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

LifecycleState -> (строка)

Описание текущего состояния жизненного цикла. Состояние Quarantined не используется. Более подробную информацию см. в разделе «Жизненный цикл экземпляра Amazon EC2 Auto Scaling» в руководстве пользователя Amazon EC2 Auto Scaling.

HealthStatus -> (строка)

Последнее зарегистрированное состояние работоспособности экземпляра. Healthy означает, что экземпляр работоспособен и должен оставаться в службе. Unhealthy означает, что экземпляр неисправен и Amazon EC2 Auto Scaling должен завершить его работу и заменить.

LaunchConfigurationName -> (строка)

Конфигурация запуска, связанная с экземпляром.

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

Шаблон запуска для экземпляра.

LaunchTemplateId -> (строка)

Идентификатор шаблона запуска. Для получения идентификатора шаблона используйте операцию API Amazon EC2 DescribeLaunchTemplates. Новые шаблоны запуска могут быть созданы с помощью операции API Amazon EC2 CreateLaunchTemplate.

Условие: вы должны указать либо LaunchTemplateId, либо LaunchTemplateName.

LaunchTemplateName -> (строка)

Имя шаблона запуска. Для получения имени шаблона используйте операцию API Amazon EC2 DescribeLaunchTemplates. Новые шаблоны запуска могут быть созданы с помощью операции API Amazon EC2 CreateLaunchTemplate.

Условие: вы должны указать либо LaunchTemplateId, либо LaunchTemplateName.

Version -> (строка)

Номер версии, $Latest или $Default. Для получения номера версии используйте операцию API Amazon EC2 DescribeLaunchTemplateVersions. Новые версии шаблонов запуска могут быть созданы с помощью операции API Amazon EC2 CreateLaunchTemplateVersion. Если значение равно $Latest, Amazon EC2 Auto Scaling выбирает последнюю версию шаблона запуска при запуске экземпляров. Если значение равно $Default, Amazon EC2 Auto Scaling выбирает версию шаблона запуска по умолчанию при запуске экземпляров. Значение по умолчанию — $Default.

ProtectedFromScaleIn -> (логическое значение)

Указывает, защищён ли экземпляр от завершения работы Amazon EC2 Auto Scaling при уменьшении масштаба.

WeightedCapacity -> (строка)

Количество единиц ёмкости, предоставляемых экземпляром на основе его типа.

Диапазон допустимых значений: минимальное значение 1, максимальное 999.

NextToken -> (строка)

Эта строка указывает, что ответ содержит больше элементов, чем может быть возвращено в одном ответе. Для получения дополнительных элементов укажите эту строку в качестве значения NextToken при запросе следующего набора элементов. Это значение равно null, когда больше возвращаемых элементов нет.

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

Spec-Zone.ru

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