[ aws . cloudformation ]
list-stack-instances
Описание
Возвращает сводную информацию о экземплярах стеков, связанных с указанным набором стеков. Вы можете фильтровать экземпляры стеков, связанные с определённым именем учётной записи Amazon Web Services или регионом, или имеющие определённый статус.
См. также: Документацию API AWS
list-stack-instances — это постраничная операция. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Summaries
Синтаксис
list-stack-instances
--stack-set-name <value>
[--filters <value>]
[--stack-instance-account <value>]
[--stack-instance-region <value>]
[--call-as <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]
Параметры
--stack-set-name (строка)
--filters (список)
Фильтр, применяемый к экземплярам стеков
(структура)
Фильтр, применяемый к экземплярам стеков
Name -> (строка)
Values -> (строка)
Сокращенный синтаксис:
Name=string,Values=string ...
Синтаксис JSON:
[
{
"Name": "DETAILED_STATUS"|"LAST_OPERATION_ID"|"DRIFT_STATUS",
"Values": "string"
}
...
]
--stack-instance-account (строка)
--stack-instance-region (строка)
--call-as (строка)
[Права, управляемые службой] Указывает, действуете ли вы как администратор учётной записи в учётной записи управления организацией или как делегированный администратор в учётной записи участника.
По умолчанию, задан SELF. Используйте SELF для наборов стеков с правами самообслуживания.
- Если вы вошли в систему в учётной записи управления, укажите
SELF. - Если вы вошли в систему в учётной записи делегированного администратора, укажите
DELEGATED_ADMIN. Ваша учётная запись Amazon Web Services должна быть зарегистрирована как делегированный администратор в учётной записи управления. Дополнительную информацию см. в руководстве пользователя CloudFormation.
Возможные значения:
SELFDELEGATED_ADMIN
--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.
Для перечисления экземпляров стека
Следующий пример list-stack-instances перечисляет экземпляры, созданные из указанного набора стеков.
aws cloudformation list-stack-instances \
--stack-set-name enable-config
Пример выходных данных включает сведения о стеке, который не смог обновиться из-за ошибки:
{
"Summaries": [
{
"StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743",
"Region": "us-west-2",
"Account": "123456789012",
"StackId": "arn:aws:cloudformation:ap-northeast-1:123456789012:stack/StackSet-enable-config-35a6ac50-d9f8-4084-86e4-7da34d5de4c4/a1631cd0-e5fb-xmpl-b474-0aa20f14f06e",
"Status": "CURRENT"
},
{
"StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743",
"Region": "us-west-2",
"Account": "123456789012",
"StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532/eab53680-e5fa-xmpl-ba14-0a522351f81e",
"Status": "OUTDATED",
"StatusReason": "ResourceLogicalId:ConfigDeliveryChannel, ResourceType:AWS::Config::DeliveryChannel, ResourceStatusReason:Failed to put delivery channel 'StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532-ConfigDeliveryChannel-1OJWJ7XD59WR0' because the maximum number of delivery channels: 1 is reached. (Service: AmazonConfig; Status Code: 400; Error Code: MaxNumberOfDeliveryChannelsExceededException; Request ID: d14b34a0-ef7c-xmpl-acf8-8a864370ae56)."
}
]
}
Вывод
Сводки -> (список)
Список структур StackInstanceSummary, содержащих информацию о заданных экземплярах стеков.
(структура)
Структура, содержащая сводную информацию об экземпляре стека.
StackSetId -> (строка)
Регион -> (строка)
Аккаунт -> (строка)
StackId -> (строка)
Статус -> (строка)
Статус экземпляра стека с точки зрения его синхронизации с связанным набором стеков.
-
INOPERABLE: ОперацияDeleteStackInstancesзавершилась неудачно и оставила стек в неустойчивом состоянии. Стеки в этом состоянии исключаются из дальнейших операцийUpdateStackSet. Возможно, потребуется выполнить операциюDeleteStackInstances, сRetainStacksустановленным на значениеtrue, для удаления экземпляра стека, а затем удалить сам стек вручную.INOPERABLEможет быть возвращено здесь, когда причиной является неудачный импорт. Если это связано с неудачным импортом, операцию можно повторить после исправления ошибок. Чтобы определить, связано ли это с неудачным импортом, вызовите операцию API DescribeStackInstance, обратившись к элементуDetailedStatus, возвращенному в элементеStackInstanceSummary. -
OUTDATED: Стек в данный момент не соответствует набору стеков, потому что:- Связанный стек завершился ошибкой во время операции
CreateStackSetилиUpdateStackSet. - Стек был частью операции
CreateStackSetилиUpdateStackSet, которая завершилась ошибкой или была остановлена до создания или обновления стека.
- Связанный стек завершился ошибкой во время операции
-
CURRENT: Стек в данный момент соответствует набору стеков.
СтатусПричина -> (строка)
StackInstanceStatus -> (структура)
Подробный статус экземпляра стека.
ПодробныйСтатус -> (строка)
-
CANCELLED: Операция в указанной учетной записи и регионе была отменена. Это либо из-за остановки операции набора стеков пользователем, либо из-за превышения порога допуска ошибок для операции набора стеков. -
FAILED: Операция в указанной учетной записи и регионе завершилась неудачно. Если операция набора стеков завершается неудачей в достаточном количестве учетных записей в регионе, может быть превышен порог допуска ошибок для всей операции набора стеков. -
FAILED_IMPORT: Импорт экземпляра стека в указанной учетной записи и регионе завершился неудачей и оставил стек в неустойчивом состоянии. После устранения причин сбоя операцию импорта можно повторить. Если достаточно операций набора стеков завершаются неудачей в достаточном количестве учетных записей в регионе, может быть превышен порог допуска ошибок для всей операции набора стеков. -
INOPERABLE: ОперацияDeleteStackInstancesзавершилась неудачно и оставила стек в неустойчивом состоянии. Стеки в этом состоянии исключаются из дальнейших операцийUpdateStackSet. Возможно, потребуется выполнить операциюDeleteStackInstances, сRetainStacksустановленным на значениеtrue, для удаления экземпляра стека, а затем удалить сам стек вручную. -
PENDING: Операция в указанной учетной записи и регионе еще не началась. -
RUNNING: Операция в указанной учетной записи и регионе в настоящее время выполняется. -
SKIPPED_SUSPENDED_ACCOUNT: Операция в указанной учетной записи и регионе была пропущена, поскольку учетная запись была приостановлена во время операции. -
SUCCEEDED: Операция в указанной учетной записи и регионе успешно завершена.
OrganizationalUnitId -> (строка)
СтатусОтклонения -> (строка)
Статус фактической конфигурации экземпляра стека по сравнению с ожидаемой конфигурацией шаблона и параметров набора стеков, к которому он принадлежит.
-
DRIFTED: Стек отличается от ожидаемой конфигурации шаблона и параметров набора стеков, к которому он принадлежит. Экземпляр стека считается отклонившимся, если один или несколько ресурсов в связанном стеке отклонились. -
NOT_CHECKED: CloudFormation не проверял, отличается ли экземпляр стека от его ожидаемой конфигурации набора стеков. -
IN_SYNC: Фактическая конфигурация экземпляра стека соответствует ожидаемой конфигурации набора стеков. -
UNKNOWN: Это значение зарезервировано для будущего использования.
ПоследнееВремяПроверкиОтклонений -> (метка времени)
NULL для любого экземпляра стека, для которого обнаружение отклонений еще не выполнено.ПоследнийИдентификаторОперации -> (строка)
NextToken -> (строка)
NextToken устанавливается в маркер. Чтобы получить следующий набор результатов, вызовите ListStackInstances снова и присвойте этот маркер параметру NextToken объекта запроса. Если запрос возвращает все результаты, NextToken устанавливается на null.
© Copyright 2025, Amazon Web Services. Created using Sphinx.