1. 接口描述
接口请求域名：
iot.cloud.tencent.com/api/exploreropen/tokenapi。
本接口（AppGetFamilySubDeviceList）用于获取家庭下网关的子设备列表。2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数，AccessToken 用于对一个已经登录的用户鉴权。 |
RequestId | String | 是 | 公共参数，唯一请求 ID，可自行生成，推荐使用 uuId。定位问题时，需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数，本接口取值：AppGetFamilySubDeviceList。 |
GatewayProductId | String | 是 | 网关设备产品 ID。 |
GatewayDeviceName | String | 是 | 网关设备 Name。 |
Offset | Int | 是 | 消息偏移量。 |
Limit | Int | 是 | 最大返回消息条数，最大值为50。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数，唯一请求 ID，可自行生成，推荐使用 uuId。定位问题时，需提供该次请求的 RequestId。 |
Total | String | 总数量。 |
DeviceList | Array of DeviceList | 设备列表。 |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "req_1","Action": "AppGetFamilySubDeviceList","GatewayProductId":"NJ27OVLZT4","GatewayDeviceName":"gwdev","Offset":0,"Limit":2,"AccessToken": "8b4a70dd16105f******************18edd4e78a3bb8ec"}
输出示例
{"Response": {"DeviceList": [{"FamilyId": "f_9b309d84c962****0a11b4c3d9588fcc1","ProductId": "LAEG4YJE1A","DeviceName": "subdev1","DeviceId": "LAEG4YJE1A/subdev1","AliasName": "","RoomId": "0","IconUrl": "","DeviceType": 2,"CreateTime": 1583492992,"UpdateTime": 1583492992}],"RequestId": "req_1","Total": 1}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
InternalError.InternalRPCError | 调用超时。 |
InternalError.InternalRPCError | 调用返回失败。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAccessToken | Token 无效。 |
InvalidParameterValue.NoPermission | 用户对该设备无权限。 |
UnsupportedOperation | 不支持的操作。 |
UnsupportedOperation.ERR_APP_INVALID_IOTAPPID | App 无效 IotAppID。 |
ResourceNotFound | 资源不存在 |
ResourceNotFound.DeviceNotExist | 设备未创建或是已删除 |
