Метод list
Возвращает список реестров в указанном каталоге.
HTTP-запрос
GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/registries
Query-параметры
Параметр | Описание |
---|---|
folderId | Обязательное поле. Идентификатор каталога для получения списка реестров. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50. |
pageSize | Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем page_size , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
pageToken | Токен страницы. Установите значение page_token равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
Ответ
HTTP Code: 200 - OK
{
"registries": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"logGroupId": "string"
}
],
"nextPageToken": "string"
}
Поле | Описание |
---|---|
registries[] | object Реестр. Дополнительные сведения см. в разделе Реестр. |
registries[]. id |
string Идентификатор реестра. |
registries[]. folderId |
string Идентификатор каталога, которому принадлежит реестр. |
registries[]. createdAt |
string (date-time) Время создания. Строка в формате RFC3339. |
registries[]. name |
string Название реестра. Имя уникально в рамках каталога. |
registries[]. description |
string Описание реестра. Длина описания должна быть от 0 до 256 символов. |
registries[]. labels |
object Метки группы размещения в формате |
registries[]. status |
string Статус реестра.
|
registries[]. logGroupId |
string Идентификатор группы журналов для указанного реестра. |
nextPageToken | string Токен для получения следующей страницы списка. Если количество результатов больше чем pageSize, используйте Все последующие запросы будут получать свои значения |