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
Parameter | Description |
---|---|
registryId | Required. ID of the registry to list aliases for device topic. To get a registry ID make a list request. The maximum string length in characters is 50. |
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page that should be returned. If the number of available results is larger than Acceptable values are 0 to 1000, inclusive. |
pageToken | 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[] | object List of device aliases for the specified registry. |
aliases[]. deviceId |
string ID of the device that the alias belongs to. |
aliases[]. topicPrefix |
string Prefix of a canonical topic name to be aliased, e.g. |
aliases[]. alias |
string Alias of a device topic. |
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |