[ aws . autoscaling ]
describe-auto-scaling-instances
Описание
Получает информацию об экземплярах Auto Scaling в учетной записи и регионе.
См. также: Документацию API AWS
describe-auto-scaling-instances — это страничная операция. Для получения всего набора результатов могут потребоваться несколько API-вызовов. Вы можете отключить страничную навигацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на страничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: AutoScalingInstances
Синтаксис
describe-auto-scaling-instances
[--instance-ids <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]
Параметры
--instance-ids (список)
Идентификаторы экземпляров. Если этот параметр опущен, описываются все экземпляры Auto Scaling. Если указан несуществующий идентификатор, он игнорируется без ошибки.
Элементы массива: Максимальное количество 50 элементов.
(строка)
Синтаксис:
"string" "string" ...
--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, сопоставленного с двоичным блоком, 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.
За исключением случаев, когда указано иное, во всех примерах используются правила цитирования unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Пример 1: Описание одного или нескольких экземпляров
В этом примере описывается указанный экземпляр.
aws autoscaling describe-auto-scaling-instances \
--instance-ids i-06905f55584de02da
Вывод:
{
"AutoScalingInstances": [
{
"InstanceId": "i-06905f55584de02da",
"InstanceType": "t2.micro",
"AutoScalingGroupName": "my-asg",
"AvailabilityZone": "us-west-2b",
"LifecycleState": "InService",
"HealthStatus": "HEALTHY",
"ProtectedFromScaleIn": false,
"LaunchTemplate": {
"LaunchTemplateId": "lt-1234567890abcde12",
"LaunchTemplateName": "my-launch-template",
"Version": "1"
}
}
]
}
Пример 2: Описание одного или нескольких экземпляров
В этом примере используется параметр --max-items для указания количества экземпляров, которое должно быть возвращено в этом вызове.
aws autoscaling describe-auto-scaling-instances \
--max-items 1
Если вывод включает поле NextToken, есть больше экземпляров. Для получения дополнительных экземпляров используйте значение этого поля с параметром --starting-token в последующем вызове, как показано ниже.
aws autoscaling describe-auto-scaling-instances \
--starting-token Z3M3LMPEXAMPLE
См. пример 1 для примера вывода.
Пример 3: Описание экземпляров, использующих конфигурации запуска
В этом примере используется параметр --query для описания экземпляров, использующих конфигурации запуска.
aws autoscaling describe-auto-scaling-instances \
--query 'AutoScalingInstances[?LaunchConfigurationName!=`null`]'
Вывод:
[
{
"InstanceId": "i-088c57934a6449037",
"InstanceType": "t2.micro",
"AutoScalingGroupName": "my-asg",
"AvailabilityZone": "us-west-2c",
"LifecycleState": "InService",
"HealthStatus": "HEALTHY",
"LaunchConfigurationName": "my-lc",
"ProtectedFromScaleIn": false
}
]
Дополнительную информацию см. в разделе Фильтрация вывода AWS CLI в Руководстве пользователя AWS Command Line Interface.
Вывод
AutoScalingInstances -> (список)
Экземпляры.
(структура)
Описание экземпляра EC2, связанного с группой автоматического масштабирования.
InstanceId -> (строка)
InstanceType -> (строка)
AutoScalingGroupName -> (строка)
AvailabilityZone -> (строка)
LifecycleState -> (строка)
Состояние жизненного цикла экземпляра. Состояние Quarantined не используется. Дополнительную информацию см. в руководстве пользователя Amazon EC2 Auto Scaling, раздел «Жизненный цикл экземпляра Amazon EC2 Auto Scaling».
Допустимые значения: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching | Detached | EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait | Warmed:Pending:Proceed | Warmed:Terminating | Warmed:Terminating:Wait | Warmed:Terminating:Proceed | Warmed:Terminated | Warmed:Stopped | Warmed:Running
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 -> (булево)
WeightedCapacity -> (строка)
Количество единиц емкости, вносимых экземпляром на основе его типа.
Диапазон допустимых значений: минимальное значение 1, максимальное значение 999.
NextToken -> (строка)
NextToken при запросе следующего набора элементов. Это значение равно null, когда больше элементов возвращать не нужно.
© Copyright 2025, Amazon Web Services. Created using Sphinx.