同步调用设备动作

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

1. 接口描述

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

为用户提供同步调用设备动作的能力。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CallDeviceActionSync
Version String 公共参数,本接口取值:2019-04-23
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-guangzhou-open
ProductId String 产品Id
DeviceName String 设备名称
ActionId String 动作Id
InputParams String 输入参数

3. 输出参数

参数名称 类型 描述
ClientToken String 调用Id
OutputParams String 输出参数
注意:此字段可能返回 null,表示取不到有效值。
Status String 返回状态
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 同步调用设备动作

同步调用设备动作,返回调用结果。

输入示例

https://iotcloud.tencentcloudapi.com/?Action=CallDeviceActionSync
&ProductId=TOIDHQ3AOQ
&DeviceName=light1
&ActionId=actid
&InputParams={"vol":4}
&<公共请求参数>

输出示例

{
  "Response": {
    "ClientToken": "0fe1260b7a724b67ba873ca7df703e0d",
    "OutputParams": "{\"brightness\":1,\"color\":1,\"light_switch\":1}",
    "RequestId": "235fe48b-0c31-4a7c-aaf6-83ba3e9s4bcf",
    "Status": "succ"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ActionUnreachable 动作消息不可达。
InternalError 内部错误。
InternalError.DBOpertaionError DB操作错误。
InternalError.InternalRPCError 内部RPC错误。
InvalidParameter.ActionInputParamsInvalid 动作输入参数不合法。
InvalidParameterValue.ActionNilOrNotExist 动作为空或不存在。
InvalidParameterValue.ModelDefineNil 物模型为空。
InvalidParameterValue.ModelPropertyNotExist 属性ID不存在。
ResourceNotFound.DeviceNotExist 设备不存在。
ResourceNotFound.StudioProductNotExist 产品不存在。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoPermissionToStudioProduct 产品ACL错误。