IoT Core Service, gRPC: RegistryService.ListDeviceTopicAliases
Retrieves the list of device topic aliases for the specified registry.
gRPC request
rpc ListDeviceTopicAliases (ListDeviceTopicAliasesRequest) returns (ListDeviceTopicAliasesResponse)
ListDeviceTopicAliasesRequest
{
"registry_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
registry_id |
string Required field. ID of the registry to list aliases for device topic. To get a registry ID make a RegistryService.List request. |
|
page_size |
int64 The maximum number of results per page that should be returned. If the number of available |
|
page_token |
string Page token. To get the next page of results, set |
ListDeviceTopicAliasesResponse
{
"aliases": [
{
"device_id": "string",
"topic_prefix": "string",
"alias": "string"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
aliases[] |
List of device aliases for the specified registry. |
|
next_page_token |
string Token for getting the next page of the list. If the number of results is greater than Each subsequent page will have its own |
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 |
|
device_id |
string ID of the device that the alias belongs to. |
|
topic_prefix |
string Prefix of a canonical topic name to be aliased, e.g. |
|
alias |
string Alias of a device topic. |