[ aws . greengrassv2 ]
list-core-devices
Описание
Получает постраничный список устройств ядра Greengrass.
Примечание
IoT Greengrass полагается на отдельные устройства для отправки обновлений состояния в облако Amazon Web Services. Если программное обеспечение IoT Greengrass Core не работает на устройстве или устройство не подключено к облаку Amazon Web Services, то сообщаемое состояние этого устройства может не отражать его текущее состояние. Отметка времени состояния указывает, когда состояние устройства было в последний раз обновлено.
Устройства ядра отправляют обновления состояния в следующие моменты:
- При запуске программного обеспечения IoT Greengrass Core
- При получении устройством ядра развертывания из облака Amazon Web Services
- Для ядра Greengrass версии 2.12.2 и ранее, устройство ядра отправляет обновления состояния, когда состояние любого компонента на устройстве ядра становится
ERROREDилиBROKEN. - Для ядра Greengrass версии 2.12.3 и более поздних версий, устройство ядра отправляет обновления состояния, когда состояние любого компонента на устройстве ядра становится
ERRORED,BROKEN,RUNNINGилиFINISHED. - С регулярным интервалом, который можно настроить, по умолчанию он составляет 24 часа
- Для IoT Greengrass Core v2.7.0, устройство ядра отправляет обновления состояния при локальном и облачном развертывании
См. также: Документацию API AWS
list-core-devices — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: coreDevices
Синтаксис
list-core-devices
[--thing-group-arn <value>]
[--status <value>]
[--runtime <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]
Параметры
--thing-group-arn (строка)
--status (строка)
Состояние устройства ядра, по которому выполняется фильтрация. Если вы укажете этот параметр, в списке будут только устройства ядра с этим состоянием. Выберите один из следующих вариантов:
-
HEALTHY– Программное обеспечение IoT Greengrass Core и все компоненты работают на устройстве ядра без проблем. -
UNHEALTHY– Программное обеспечение IoT Greengrass Core или компонент находятся в состоянии сбоя на устройстве ядра.
Возможные значения:
HEALTHYUNHEALTHY
--runtime (строка)
Используемая средой выполнения устройства ядра. Среда выполнения может быть:
aws_nucleus_classicaws_nucleus_lite
--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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из файла ключей.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- on
- off
- auto
--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-core-devices списка устройств ядра AWS IoT Greengrass в вашей учетной записи AWS в текущем регионе.
aws greengrassv2 list-core-devices
Вывод:
{
"coreDevices": [
{
"coreDeviceThingName": "MyGreengrassCore",
"status": "HEALTHY",
"lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00"
}
]
}
Дополнительную информацию см. в разделе Проверка состояния устройства ядра в Руководстве разработчика AWS IoT Greengrass V2.
Вывод
coreDevices -> (список)
Список, обобщающий каждое устройство ядра.
(структура)
Содержит информацию об устройстве ядра Greengrass, которое представляет собой устройство IoT, на котором выполняется программное обеспечение IoT Greengrass Core.
coreDeviceThingName -> (строка)
status -> (строка)
Состояние устройства ядра. Устройства ядра могут иметь следующие состояния:
-
HEALTHY– Программное обеспечение IoT Greengrass Core и все компоненты работают на устройстве ядра без проблем. -
UNHEALTHY– Программное обеспечение IoT Greengrass Core или компонент находятся в состоянии сбоя на устройстве ядра.
lastStatusUpdateTimestamp -> (метка времени)
platform -> (строка)
architecture -> (строка)
runtime -> (строка)
Среда выполнения для устройства ядра. Среда выполнения может быть:
aws_nucleus_classicaws_nucleus_lite
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.