Метод list

HTTP-запрос
Query-параметры
Ответ

Возвращает список устройств в указанном реестре.

HTTP-запрос

GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/devices

Query-параметры

Параметр	Описание
registryId	Идентификатор реестра для получения списка устройств. Чтобы получить идентификатор реестра, используйте запрос list. Максимальная длина строки в символах — 50.
folderId	Идентификатор каталога для получения списка устройств. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50.
pageSize	Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем `page_size` , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
pageToken	Токен страницы. Установите значение `page_token` равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

{
  "devices": [
    {
      "id": "string",
      "registryId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "topicAliases": "object"
    }
  ],
  "nextPageToken": "string"
}

Поле	Описание
devices[]	object Устройство. Дополнительные сведения см. в разделе Устройство.
devices[]. id	string Идентификатор устройства.
devices[]. registryId	string Идентификатор реестра, к которому принадлежит устройство.
devices[]. createdAt	string (date-time) Время создания. Строка в формате RFC3339.
devices[]. name	string Имя устройства. Имя является уникальным в рамках реестра.
devices[]. description	string Описание устройства. Длина описания должна быть от 0 до 256 символов.
devices[]. topicAliases	object Алиас топика устройства. Алиас — это альтернативное имя топика устройства, назначенное пользователем. Алиас сопоставляется со стандартным топиком, например `my/custom/alias` эквивалентен `$device/abcdef/events`.
nextPageToken	string Токен для получения следующей страницы списка. Если количество результатов больше чем pageSize, используйте `next_page_token` в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения `next_page_token` для перебора страниц результатов.