GetThingTopo
GetThingTopo
调用该接口查询指定网关设备的子设备列表。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | GetThingTopo | 系统规定参数。取值：GetThingTopo。 |
PageNo | Integer | 是 | 1 | 从返回结果中的第几页开始显示。 |
PageSize | Integer | 是 | 10 | 返回结果中每页显示的记录数量。最大值不超过50。 |
ProductKey | String | 否 | a1BwAGV**** | 网关设备所属的产品ProductKey。 |
DeviceName | String | 否 | light | 网关设备的名称。 |
IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 | 网关设备ID。物联网平台为该网关设备颁发的ID，设备的唯一标识符。 |
‼️ 注意：调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
Code | String | iot.system.SystemException | 调用失败时，返回的错误码。更多信息，请参见错误码。 |
Data | Struct | 调用成功时，返回的数据。详情请参见以下参数。 | |
CurrentPage | Integer | 1 | 当前页码。 |
List | Array of deviceInfo | 子设备信息集合（deviceInfo）。 | |
deviceInfo | |||
DeviceName | String | light | 子设备名称。 |
IotId | String | Q7uOhVRdZRRlDnTLv****00100 | 子设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。 |
ProductKey | String | a1BwAGV**** | 子设备所属的产品ProductKey。 |
PageCount | Long | 1 | 总页数。 |
PageSize | Integer | 10 | 每页显示的记录数。 |
Total | Long | 1 | 总记录数。 |
ErrorMessage | String | 系统异常 | 调用失败时，返回的出错信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 为该请求生成的唯一标识符。 |
Success | Boolean | true | 表示是否调用成功。
|
示例
请求示例
curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=GetThingTopo&SignatureNonce=66f0aa750ce248c7b7eba0fc4b2a071f&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A45%3A14Z&ProductKey=k1ymv1DuLfE&DeviceName=myTestDevice&Signature=FWLGpMgANBXy8jfNfyPeICS3rm4%3D'正常返回示例
{
"Data": {
"PageCount": 1,
"PageSize": 2,
"CurrentPage": 1,
"List": {
"deviceInfo": [
{
"DeviceName": "APItest",
"ProductKey": "a1T27vz****",
"IotId": "vWxNur6BUApsqjv****000100"
}
]
},
"Total": 1
},
"RequestId": "93F05C63-9FD1-4CC8-B0FF-6D6C1A6632D1",
"Success": true
}