设备远程控制

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

1. 接口描述

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

根据设备产品ID、设备名称,设置控制设备的属性数据。

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
Data String 返回信息
Result String JSON字符串, 返回下发控制的结果信息,
Sent = 1 表示设备已经在线并且订阅了控制下发的mqtt topic
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 设置设备数据

设置设备数据

输入示例

https://iotexplorer.tencentcloudapi.com/?Action=ControlDeviceData
&ProductId=LJ0INDNU7U
&DeviceName=light1
&Data={"brightness":1}
&<公共请求参数>

输出示例

{
  "Response": {
    "Data": "",
    "RequestId": "5c982342-fb08-4fac-8e70-f63834667b52"
  }
}

示例2 设置设备数据

设置设备数据

输入示例

https://iotexplorer.tencentcloudapi.com/?Action=ControlDeviceData
&ProductId=BKTTNGIQOG
&DeviceName=dev01
&Data={"payload":"test","id":"abc"}
&<公共请求参数>

输出示例

{
  "Response": {
    "Data": "",
    "RequestId": "235fe48b-0c31-4a7c-aaf6-83ba3e9b4bcf",
    "Result": "{\"Sent\":1,\"pushResult\":0}"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.DBOpertaionError DB操作错误。
InternalError.InternalRPCError 内部RPC错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ModelDefineEventPropNameError 物模型事件/属性 Name 错误。
InvalidParameterValue.ModelDefineInvalid 数据模板未定义。
InvalidParameterValue.ModelDefineNil 物模型为空。
ResourceNotFound.DeviceNotExist 设备不存在。
ResourceNotFound.ProductNotExist 产品不存在。
ResourceNotFound.ProductOrDeviceNotExist 产品或设备不存在。
ResourceNotFound.StudioProductNotExist 产品不存在。
UnauthorizedOperation 未授权操作。