调用该接口查询指定网关设备的子设备列表。

限制说明

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为500。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetThingTopo

系统规定参数。取值：GetThingTopo。
PageNo Integer 是 1

从返回结果中的第几页开始显示。
PageSize Integer 是 10

返回结果中每页显示的记录数量。最大值不超过50。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

实例ID。

必须传入实例ID，否则调用会失败。您可在物联网平台控制台的实例概览页面，查看您的实例ID。

注意

如果公共实例没有ID，请参见如何获取实例ID。

ProductKey String 否 a1BwAGV****

网关设备所属的产品ProductKey。

说明 如果传入该参数，需同时传入DeviceName。
DeviceName String 否 light

网关设备的名称。

说明 如果传入该参数，需同时传入ProductKey。
IotId String 否 Q7uOhVRdZRRlDnTLv****00100

网关设备ID。物联网平台为该网关设备颁发的ID，设备的唯一标识符。

说明 如果传入该参数，则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符，和ProductKey与DeviceName组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName组合，则以IotId为准。

调用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

表示是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=GetThingTopo
&ProductKey=a1BwAGV****
&DeviceName=device1
&PageSize=10
&PageNo=1
&<公共请求参数>

正常返回示例

XML格式 

<GetThingTopoResponse>
  <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>
</GetThingTopoResponse>

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
}