物联网开发平台
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 物联网开发平台 > 应用端开发指南 > 应用端 API > 设备管理 > 获取指定网关设备的子设备列表

获取指定网关设备的子设备列表

最近更新时间：2023-07-17 18:26:01

我的收藏

本页目录：

1. 接口描述

接口请求域名： iot.cloud.tencent.com/api/exploreropen/tokenapi。 本接口（AppGetGatewayBindDeviceList）用于获取指定网关设备的子设备列表。

2. 输入参数

名称
类型
必选
描述
AccessToken
String
是
公共参数，AccessToken 用于对一个已经登录的用户鉴权。
RequestId
String
是
公共参数，唯一请求 ID，可自行生成，推荐使用 uuId。定位问题时，需提供该次请求的 RequestId。
Action
String
是
公共参数，本接口取值：AppGetGatewayBindDeviceList。
ProductId
String
是
子设备的 ProductId。
GatewayProductId
String
是
网关设备的 ProductId。
GatewayDeviceName
String
是
网关设备的 DeviceName。
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.1
content-type: application/json 
{
    "RequestId": "req_1",
    "Action": "AppGetGatewayBindDeviceList",
    "ProductId":"LAEG4YJE1A",  //子设备的productId
    "GatewayProductId":"NJ27OVLZT4",  //网关设备的productId
    "GatewayDeviceName":"gwdev",   //网关设备的deviceName
    "Offset":0,
    "Limit":2,
    "AccessToken": "8b4a70dd16105f******************18edd4e78a3bb8ec"
}
输出示例
{
    "Response": {
            "DeviceList": [{
                "ProductId": "LAEG4YJE1A",  
                "DeviceName": "subdev2",    //子设备的deviceName
                "DeviceId": "LAEG4YJE1A/subdev2", //子设备的deviceId
                "AliasName": "",
                "IconUrl": "",
                "BindStatus": 0   //未绑定到家庭
            }, {
                "ProductId": "LAEG4YJE1A",
                "DeviceName": "subdev1",
                "DeviceId": "LAEG4YJE1A/subdev1",
                "AliasName": "",
                "IconUrl": "",
                "BindStatus": 1  //已经绑定到家庭
            }],
            "RequestId": "req_1",
            "Total": 2
    }
}

5. 错误码

错误码
描述
InternalError
内部错误。
InternalError.InternalRPCError
调用超时。
InternalError.InternalRPCError
调用返回失败。
InvalidParameterValue
参数取值错误。
InvalidParameterValue.InvalidAccessToken
Token 无效。
UnsupportedOperation
不支持的操作。
UnsupportedOperation.NotSupportVirtualDevice
不支持虚拟设备。
UnsupportedOperation.DeviceNotGateway
不是网关设备。
ResourceNotFound
资源不存在。
ResourceNotFound.DeviceNotExist
设备未创建或是已删除。
ResourceNotFound.StudioMemberNotExist
家庭成员未创建或是已删除。

中国站