Метод listDeviceTopicAliases
Возвращает список алиасов устройств для указанного реестра.
HTTP-запрос
GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/registries/{registryId}:listDeviceTopicAliases
Path-параметры
Параметр | Описание |
---|---|
registryId | Обязательное поле. Идентификатор реестра для получения списка алиасов для топика устройства. Чтобы получить идентификатор реестра, используйте запрос list. Максимальная длина строки в символах — 50. |
Query-параметры
Параметр | Описание |
---|---|
pageSize | Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем page_size , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
pageToken | Токен страницы. Установите значение page_token равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
Ответ
HTTP Code: 200 - OK
{
"aliases": [
{
"deviceId": "string",
"topicPrefix": "string",
"alias": "string"
}
],
"nextPageToken": "string"
}
Поле | Описание |
---|---|
aliases[] | object Алиас топика устройства. Алиас — это альтернативное имя топика устройства, назначенное пользователем. Алиас сопоставляется со стандартным топиком, например |
aliases[]. deviceId |
string Идентификатор устройства, которому принадлежит алиас. |
aliases[]. topicPrefix |
string Префикс алиаса стандартного топика устройства, например |
aliases[]. alias |
string Алиас топика устройства. |
nextPageToken | string Токен для получения следующей страницы списка. Если количество результатов больше чем pageSize, используйте Все последующие запросы будут получать свои значения |