调用该接口提供根据网关设备ID查询子设备列表。

路径 /living/cloud/device/subdevice/query
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权 否
超时时间 10000

请求参数

名称类型是否必选示例值描述
名称 类型 是否必选 示例值 描述
productKey String 否 产品的Key，设备证书信息之一。创建产品时，生活物联网平台为该产品颁发的全局唯一标识。
deviceName String 否 设备的名称，设备证书信息之一。在注册设备时，自定义的或系统生成的设备名称，具备产品维度内的唯一性。
iotId String 否 设备ID，生活物联网平台为设备颁发的ID，设备的唯一标识符。
pageNo Int 否 分页查询的页码。
pageSize Int 否 分页查询的每页大小，最大值为20。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
code Int

接口返回码。200表示成功。
message String

调用失败时，返回的出错信息。
localizedMsg String

本地语言的错误消息。
data JSON

响应结果。
total Long

子设备总数。
pageNo Int

从1开始的当前查询的分页页码。
pageSize Int

当前查询的分页尺寸。
items JSON

子设备列表。
iotId String

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

设备的名称，设备证书信息之一。在注册设备时，自定义的或系统生成的设备名称，具备产品维度内的唯一性。
productKey String

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

设备的类型：VIRTUAL、WEB、APP、DEVICE。
firmwareVersion String

固件版本号，需要设备端上报。如果未上报过，则不会返回该值。
status Int

设备状态。0（表示未激活）；1（表示在线）；3（表示离线）；8（表示禁用）。
nodeType String

设备节点类型：DEVICE、GATEWAY。
region String

设备所属的站点。
rbacTenantId String

设备所属的租户ID。
gmtCreate Long

记录创建时间，1970年01月01日起至现在的总毫秒数。
gmtModified Long

记录修改时间，1970年01月01日起至现在的总毫秒数。
sdkVersion String

SDK版本号。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0"
	},
	"params":{
		"productKey": "value0",
		"deviceName": "value1",
		"iotId": "value2",
		"pageNo": "value3",
		"pageSize": "value4"
	}
}

正常返回示例

JSON 格式 

{
    "code":200,
    "data":{
        "total":1,
        "pageNo":1,
        "pageSize":10,
        "items":[
            {
                "iotId":"c2NBjWQUxxxxxxxxTPFu8000101",
                "gmtModified":"15789xxxx6000",
                "thingType":"DEVICE",
                "productKey":"a1HxxxxRiox",
                "region":"cn-hangzhou",
                "gmtCreate":"15789xxxx6000",
                "deviceName":"tesxxxxv0",
                "rbacTenantId":"380D6988CxxxxxxxxxD9CBBDAC071",
                "status":0
            }
        ]
    },
    "id":"3f757e2b-xxxx-xxxx-9926-b435bfe4bb6e"
}

异常返回示例

JSON 格式 

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}