查询设备Topic列表
功能介绍
通过调用API查询Topic名称、Topic id、Topic权限、关于此Topic的说明等信息。
URI
GET /v1/{project_id}/link/instances/{instance_id}/topics
参数 |
类型 |
是否必填 |
说明 |
---|---|---|---|
project_id |
string |
是 |
租户每个区域对应的项目ID。 |
instance_id |
string |
是 |
租户使用ROMA Connect的实例ID。 |
device_name |
string |
是 |
根据输入的设备名称查询。 |
product_name |
string |
是 |
根据输入的产品名称查询。 |
请求消息
请求参数
无
请求示例
https://example.cloud.com/v1/80e2b******f4a398d6409a50932d917/link/instances/fb3b24ab-5d87-473d-9c57-fc6******6a1/topics?device_name=device01& product_name =product01
响应消息
响应参数
响应参数为数组元素。
名称 |
类型 |
描述 |
---|---|---|
数组元素 |
Array<topic> |
Topic列表信息。 |
名称 |
类型 |
描述 |
---|---|---|
remark |
string |
描述信息,不能超过200个字符。 |
topic_id |
integer |
Topic的ID。
|
topic_name |
string |
Topic名。 |
topic_perm |
string |
Topic的权限,只支持pub或sub两种权限。 |
响应示例
[ { "remark": "Pub Topics", "topic_id": 122, "topic_name": "lozrWs4y7218/out/device01", "topic_perm": "pub" }, { "remark": "Sub Topics", "topic_id": 123, "topic_name": "lozrWs4y7218/in/device01", "topic_perm": "sub" }, { "remark": "Update Shadow Topic", "topic_id": 124, "topic_name": "shadow/update/lozrWs4y7218/device01", "topic_perm": "pub" } ]