物联网开发平台
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 物联网开发平台 > 应用端开发指南 > 应用端 API > 设备分享 > 查询用户分享设备列表

查询用户分享设备列表

最近更新时间：2023-07-14 16:01:46

我的收藏

本页目录：

1. 接口描述

接口请求域名： iot.cloud.tencent.com/api/exploreropen/tokenapi。 本接口（AppListUserShareDevices）用于查询用户分享的设备列表。

2. 输入参数

名称
类型
必选
描述
AccessToken
String
是
公共参数，AccessToken 用于对一个已经登录的用户鉴权。
RequestId
String
是
公共参数，唯一请求 ID，可自行生成，推荐使用 uuid。定位问题时，需提供该次请求的 RequestId。
Action
String
是
公共参数，本接口取值：AppListUserShareDevices。
Offset
Int
是
分页偏移，0起始，最大不超过500。
Limit
Int
是
单次拉取数量，默认为10，最大不超过100。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数，唯一请求ID，与入参相同，定位问题时，需提供该次请求的 RequestId。
Total
Int
返回的消息总条数。
ShareDevices
Array of ShareDevices
响应设备信息。

4. 示例

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json
{
  "Action": "AppListUserShareDevices",
  "AccessToken": "8b4a70dd16105f******************18edd4e78a3bb8ec",
  "RequestId": "1555507****15",
  "Offset": 0,
  "Limit": 10
}
输出示例: 成功
{
  "Response": {
    "RequestId": "1555507****15",
    "ShareDevices": [
      {
        "ProductId": "WTXXXX0MF2",
        "DeviceName": "device_XXXX001",
        "DeviceId": "WTXXXX0MF2/device_XXXX001",
        "AliasName": "test_device",
        "IconUrl": "https://yyy-xxxx-xxx.cos.ap-guangzhou.myqcloud.com/113xxxx7a0b273bxxxxc0b9040feeb/1xxxxxxxxx0.png",
        "CreateTime": "2019-12-17T19:39:21+08:00"
      }
    ],
    "Total": 1
  }
}
输出示例: 失败
{
  "Response": {
    "Error": {
      "Code": "InvalidParameterValue.InvalidAccessToken",
      "Message": "Token无效"
    },
    "RequestId": "1555507****15"
  }
}

5. 错误码

错误码
描述
InternalError
内部错误。
InvalidParameterValue
参数取值错误。
InvalidParameterValue.InvalidAccessToken
Token 无效。

中国站