# GetThingTopo
调用该接口查询指定网关设备的子设备列表。
# 请求参数
# 请求方式1
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetThingTopo | 系统规定参数。取值:GetThingTopo。 |
| PageNo | Integer | 否 | 1 | 指定显示返回结果中的第几页的内容。默认值是 1。 |
| PageSize | Integer | 否 | 10 | 返回结果中每页显示的记录数量。最大值不超过50。默认值是10。 |
| IotInstanceId | String | 是 | 6912917943269**** | 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 |
| ProductKey | String | 是 | a1BwAGV**** | 网关设备所属的产品ProductKey。 |
| DeviceName | String | 是 | light | 网关设备的名称。 |
# 请求方式2
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetThingTopo | 系统规定参数。取值:GetThingTopo。 |
| PageNo | Integer | 否 | 1 | 指定显示返回结果中的第几页的内容。默认值是 1。 |
| PageSize | Integer | 否 | 10 | 返回结果中每页显示的记录数量。最大值不超过50。默认值是10。 |
| IotInstanceId | String | 是 | 6912917943269**** | 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 |
| IotId | String | 是 | Q7uOhVRdZRRlDnTLv****00100 | 网关设备ID。物联网平台为该网关设备颁发的ID,设备的唯一标识符。 |
# 返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| 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 | Integer | 92 | 总页数。 |
| PageSize | Integer | 2 | 每页显示的产品数。 |
| Total | Integer | 184 | 产品总数。 |
| ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
| RequestId | String | 5uBO0qPQCgvK6HFOSszqN5baKBaAIxfS | 平台为该请求生成的唯一标识符。 |
| Success | Boolean | true | 是否调用成功。 true:表示调用成功。 false:表示调用失败。 |
# 示例
请求示例
http://open.${区域}.fenydata.com/fenydata-java-open/?Action=GetThingTopo
&ProductKey=a1BwAGV****
&DeviceName=device1
&PageSize=10
&PageNo=1
&<公共请求参数>
正常返回示例
XML格式
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
<Data>
<PageCount>1</PageCount>
<PageSize>2</PageSize>
<CurrentPage>1</CurrentPage>
<List>
<deviceInfo>
<DeviceName>APItest</DeviceName>
<ProductKey>a1T27vz****</ProductKey>
<IotId>vWxNur6BUApsqjv****000100</IotId>
</deviceInfo>
</List>
<Total>1</Total>
</Data>
<RequestId>93F05C63-9FD1-4CC8-B0FF-6D6C1A6632D1</RequestId>
<Success>true</Success>
</xml>
JSON格式
{
"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
}