调用该接口获取网关设备的子设备列表。

路径 /subdevices/list
版本号 1.0.6
协议 HTTP,HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
iotId String 5ojQaOflI3yp1****abg00106c5910 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。
pageNo Int 1 分页页数,从1开始。
pageSize Int 10 分页页面的大小。取值大小无限制,建议小于100,当子设备较多时可能出现返回异常现象。

返回数据

名称 类型 示例值 描述
total Int

云端网关子设备的总数。

pageNo Int

当前页号。

pageSize Int

分页大小。

data JSON

子设备列表。仅返回与您存在绑定关系的网关下的子设备信息。

iotId String

设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。

productKey String

设备所属产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。

deviceName String

设备的名称。

nickName String

设备的产品名称。

image String

品类图片。

status Int

设备状态。0(表示未激活);1(表示在线);3(表示离线);8(表示禁用)。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.6",
		"iotToken": "token"
	},
	"params":{
		"iotId": "5ojQaOflI3yp1****abg00106c5910",
		"pageNo":1,
		"pageSize":10
	}
}

正常返回示例

JSON 格式

{
"code":200,
"data":[
{
"iotId":"t****ot",
"productKey":"fy2Z1oZFWZQ****kkFVM00101edf00",
"deviceName":"NET_WIFI",
"nickName":"xxxxxx",
"image":"http://abc.jpg",
"status":0
},
{
"iotId":"testIot",
"productKey":"fy2Z1oZFWZQVii6kkFVM00101edf00",
"deviceName":"NET_WIFI",
"nickName":"xxxxxx",
"image":"http://abc.jpg",
"status":0
}
],
"id":"e2d74ffe-308e-44ee-94a5-9b44a43eabc9"
}

异常返回示例

JSON 格式

{
"code":2062,
"id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
"localizedMsg":"请求错误",
"message":"identityIdnotexist"
}