IoT Core Service, REST: Registry.ListDeviceTopicAliases
Retrieves the list of device topic aliases for the specified registry.
HTTP request
GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/registries/{registryId}:listDeviceTopicAliases
Path parameters
|
Field |
Description |
|
registryId |
string Required field. ID of the registry to list aliases for device topic. The maximum string length in characters is 50. |
Query parameters
|
Field |
Description |
|
pageSize |
string (int64) The maximum number of results per page that should be returned. If the number of available Acceptable values are 0 to 1000, inclusive. |
|
pageToken |
string Page token. To get the next page of results, set The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"aliases": [
{
"deviceId": "string",
"topicPrefix": "string",
"alias": "string"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
aliases[] |
List of device aliases for the specified registry. |
|
nextPageToken |
string Token for getting the next page of the list. If the number of results is greater than |
DeviceAlias
A device topic alias.
Alias is an alternate name of a device topic assigned by the user. Map alias to canonical topic name prefix, e.g. my/custom/alias match to $device/abcdef/events. For more information, see Using topic aliases.
|
Field |
Description |
|
deviceId |
string ID of the device that the alias belongs to. |
|
topicPrefix |
string Prefix of a canonical topic name to be aliased, e.g. |
|
alias |
string Alias of a device topic. |