[ aws . greengrassv2 ]
list-installed-components
Описание
Возвращает постраничный список компонентов, запущенных на устройстве ядра Greengrass. По умолчанию этот список не включает компоненты, развернутые в качестве зависимостей других компонентов. Чтобы включить зависимости в ответ, установите параметр topologyFilter в значение ALL .
Примечание
IoT Greengrass полагается на отдельные устройства для отправки обновлений состояния в облако Amazon Web Services. Если программное обеспечение ядра IoT Greengrass не запущено на устройстве или устройство не подключено к облаку Amazon Web Services, то сообщаемое состояние этого устройства может не отражать его текущее состояние. Отметка времени состояния указывает, когда состояние устройства было обновлено в последний раз.
Устройства ядра отправляют обновления состояния в следующие моменты:
- При запуске программного обеспечения ядра IoT Greengrass
- При получении устройством ядра развертывания из облака Amazon Web Services
- При изменении состояния любого компонента на устройстве ядра до состояния
BROKEN - Через регулярные интервалы, которые можно настроить, по умолчанию равные 24 часам
- Для IoT Greengrass Core v2.7.0 устройство ядра отправляет обновления состояния при локальном и облачном развертывании
См. также: Документацию API AWS
list-installed-components — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе постраничного запроса аргумент --query должен извлекать данные из результатов следующих выражений запроса: installedComponents
Синтаксис
list-installed-components
--core-device-thing-name <value>
[--topology-filter <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]
Параметры
--core-device-thing-name (строка)
--topology-filter (строка)
Фильтр для списка компонентов. Выберите один из следующих вариантов:
-
ALL– Список включает все компоненты, установленные на устройстве ядра. -
ROOT– Список включает только корневые компоненты, которые вы указываете в развертывании. При выборе этого параметра в список не включаются компоненты, которые устройство ядра устанавливает в качестве зависимостей других компонентов.
По умолчанию: ROOT
Возможные значения:
ALLROOT
--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 для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, похожие на unix-подобные. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. Подробнее см. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.
Для перечисления компонентов, установленных на устройстве ядра
Следующий пример list-installed-components отображает компоненты, установленные на устройстве ядра AWS IoT Greengrass.
aws greengrassv2 list-installed-components \
--core-device-thing-name MyGreengrassCore
Вывод:
{
"installedComponents": [
{
"componentName": "aws.greengrass.Cli",
"componentVersion": "2.0.3",
"lifecycleState": "RUNNING",
"isRoot": true
},
{
"componentName": "aws.greengrass.Nucleus",
"componentVersion": "2.0.3",
"lifecycleState": "FINISHED",
"isRoot": true
}
]
}
Дополнительную информацию см. в разделе Проверка состояния устройства ядра в руководстве разработчика AWS IoT Greengrass V2.
Вывод
installedComponents -> (список)
Список, обобщающий каждый компонент на устройстве ядра.
Примечание
Для получения точногоlastStatusChangeTimestamp ответа требуется ядро Greengrass версии v2.7.0 или выше. В более ранних версиях ядра Greengrass этот ответ может быть неточным.Примечание
Для получения точногоlastInstallationSource и lastReportedTimestamp ответа требуется ядро Greengrass версии v2.8.0 или выше. В более ранних версиях ядра Greengrass этот ответ может быть неточным или нулевым.(структура)
Содержит информацию о компоненте на устройстве ядра Greengrass.
componentName -> (строка)
componentVersion -> (строка)
lifecycleState -> (строка)
lifecycleStateDetails -> (строка)
isRoot -> (логическое значение)
lastStatusChangeTimestamp -> (метка времени)
Статус актуальности данных.
Этот ответ основан на изменениях состояния компонента. Статус отражает сбои и развертывания компонентов. Если компонент видит только обновление конфигурации во время развертывания, он может не пройти изменение состояния, и этот статус не будет обновлен.
lastReportedTimestamp -> (метка времени)
Последнее время, когда устройство ядра Greengrass отправило сообщение, содержащее состояние компонента в облако Amazon Web Services.
Для обновления этого поля не требуется изменение состояния компонента.
lastInstallationSource -> (строка)
Источник последнего развертывания, который привел компонент на устройство ядра Greengrass. Для развертывания группы объектов или объекта, источником будет идентификатор последнего развертывания, содержащего компонент. Для локальных развертываний это будет LOCAL .
Примечание
Любое развертывание попытается переустановить неисправные компоненты на устройстве, что обновит источник последней установки.lifecycleStatusCodes -> (список)
Коды состояния, которые указывают причину сбоя, когда у lifecycleState есть ошибка или он находится в неисправном состоянии.
Примечание
Для получения точногоlifecycleStatusCodes ответа требуется ядро Greengrass версии v2.8.0 или выше. В более ранних версиях ядра Greengrass этот ответ может быть неточным.(строка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.