获取设备属性数据

最近更新时间:2019-12-05 19:43:27

1. 接口描述

接口请求域名: iotexplorer.tencentcloudapi.com 。

根据设备产品ID、设备名称,获取设备上报的属性数据。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDeviceData
Version String 公共参数,本接口取值:2019-04-23
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-guangzhou-open, ap-shanghai, ap-shenzhen
ProductId String 产品ID
DeviceName String 设备名称
DeviceId String 设备ID,该字段有值将代替 ProductId/DeviceName

3. 输出参数

参数名称 类型 描述
Data String 设备数据
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备数据

获取设备数据

输入示例

https://iotcloud.tencentcloudapi.com/?Action=DescribeDeviceData
&ProductId=LJ0INDNU7U
&DeviceName=light1
&<公共请求参数>

输出示例

{
  "Response": {
    "Data": "{\"brightness\":{\"Value\":5,\"LastUpdate\":1551432955984},\"color\":{\"Value\":11,\"LastUpdate\":1551432955984},\"name\":{\"Value\":\"light of city\",\"LastUpdate\":1551432955984}}",
    "RequestId": "5c982342-fb08-4fac-8e70-f63834667b52"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.DBOpertaionError DB操作错误。
InternalError.InternalRPCError 内部RPC错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound.DeviceNotExist 设备不存在。
ResourceNotFound.DeviceShadowNotExist 设备没有影子信息。
ResourceNotFound.ProductNotExist 产品不存在。
ResourceNotFound.ProductOrDeviceNotExist 产品或设备不存在。
UnauthorizedOperation 未授权操作。