1. 接口描述
接口请求域名：
iot.cloud.tencent.com/api/exploreropen/tokenapi。
本接口（AppGetDeviceInFamily）用于查询设备详情。 2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数，AccessToken 用于对一个已经登录的用户鉴权。 |
RequestId | String | 是 | 公共参数，唯一请求 ID，可自行生成，推荐使用 uuId。定位问题时，需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数，本接口取值：AppGetDeviceInFamily。 |
ProductId | String | 是 | 产品 ID。 |
FamilyId | String | 是 | 家庭 ID。 |
DeviceName | String | 是 | 设备名称。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数，唯一请求 ID，可自行生成，推荐使用 uuId。定位问题时，需提供该次请求的 RequestId。 |
DeviceId | String | 设备 ID，是产品 ID/设备名称组合。 |
ProductId | String | 产品 ID。 |
DeviceName | String | 设备名称。 |
AliasName | String | 设备别名。 |
IconUrl | String | 图标 URL。 |
FamilyId | String | 家庭 ID。 |
RoomId | String | 房间 ID。 |
CreateTime | Int64 | 创建时间，UNIX 秒级时间戳。 |
UpdateTime | Int64 | 最后一次更新时间，UNIX 秒级时间戳。 |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "082b70e-3d05-4179-9c94-6c70082e4a7","Action": "AppGetDeviceInFamily","ProductId":"R32ONVL0EU","FamilyId":"xxx","DeviceName":"df2eSJyY","AccessToken": "xxxv2"}
输出示例：成功
{"Response": {"Data": {"DeviceId": "R32ONVL0EU/df2eSJyY","ProductId": "R32ONVL0EU","DeviceName": "df2eSJyY","AliasName": "12345","IconUrl": "","FamilyId": "","RoomId": "","DeviceType": 0, // 0 普通 1 网关设备 2 子设备"CreateTime": 1574931773,"UpdateTime": 1574931945},"RequestId": "082b70e-3d05-4179-9c94-6c70082e4a7"}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAccessToken | Token 无效。 |
UnauthorizedOperation | 无权操作。 |
UnauthorizedOperation.APPNoPermissionToStudioProduct | App 对操作该产品无权限。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.StudioMemberNotExist | 家庭成员未创建或是已删除。 |
