设备异步命令-华为云

设备接入 IOTDA-下发异步设备命令:功能介绍

功能介绍设备的产品模型中定义了物联网平台可向设备下发的命令，应用服务器可调用此接口向指定设备下发异步命令，以实现对设备的控制。平台负责将命令发送给设备，并将设备执行命令结果异步通知应用服务器。命令执行结果支持灵活的数据流转，应用服务器通过调用物联网平台的创建规则触发条件（Resource:device.command.status，Event:update）、创建规则动作并激活规则后，当命令状态变更时，物联网平台会根据规则将结果发送到规则指定的服务器，如用户自定义的HTTP服务器，AMQP服务器，以及华为云的其他储存服务器等, 详情参考设备命令状态变更通知。注意：此接口适用于NB设备异步命令下发，暂不支持其他协议类型设备命令下发。此接口仅支持单个设备异步命令下发，如需多个设备异步命令下发，请参见创建批量任务。

设备接入 IOTDA 设备异步命令

设备接入 IOTDA-下发异步设备命令:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 device_id String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 command_id String 设备命令ID，用于唯一标识一条命令，在下发设备命令时由物联网平台分配获得。 service_id String 设备命令所属的设备服务ID，在设备关联的产品模型中定义。 command_name String 设备命令名称，在设备关联的产品模型中定义。 paras Object 设备执行的命令，Json格式，里面是一个个健值对，如果service_id不为空，每个健都是profile中命令的参数名（paraName）;如果service_id为空则由用户自定义命令格式。设备命令示例：{"value":"1"}，具体格式需要应用和设备约定。 expire_time Integer 物联网平台缓存命令的时长，单位秒。 status String 设备命令状态,如果命令被缓存，返回PENDING, 如果命令下发给设备，返回SENT。 created_time String 命令的创建时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 send_strategy String 下发策略， immediately表示立即下发，delay表示缓存起来，等数据上报或者设备上线之后下发。

设备接入 IOTDA 设备异步命令

设备接入 IOTDA-下发异步设备命令:URI

URI POST /v5/iot/{project_id}/devices/{device_id}/async-commands 表1 路径参数参数是否必选参数类型描述 project_id 是 String 参数说明：项目ID。获取方法请参见获取项目ID 。 device_id 是 String 参数说明：下发命令的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。

设备接入 IOTDA 设备异步命令

设备接入 IOTDA-下发异步设备命令:请求示例

请求示例创建异步命令，命令名为ON_OFF，命令为ON。 POST https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/async-commands { "service_id" : "reboot", "command_name" : "ON_OFF", "paras" : { "value" : "ON" }, "expire_time" : 0, "send_strategy" : "immediately" }

设备接入 IOTDA 设备异步命令

设备接入 IOTDA-下发异步设备命令:响应示例

响应示例状态码： 200 OK { "device_id" : "c1224afb-e9f0-4916-8220-b6bab568e888", "command_id" : "b1224afb-e9f0-4916-8220-b6bab568e888", "service_id" : "Switch", "command_name" : "ON_OFF", "send_strategy" : "immediately", "paras" : { "value" : "ON" }, "expire_time" : 0, "status" : "SENT", "created_time" : "20151212T121212Z" }

设备接入 IOTDA 设备异步命令

设备接入 IOTDA-下发异步设备命令:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用 IAM 服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情。表3 请求Body参数参数是否必选参数类型描述 service_id 否 String 参数说明：设备命令所属的设备服务ID，在设备关联的产品模型中定义。如设备需要编解码插件来解析命令，此参数为必填项。取值范围：长度不超过64的字符串。最大长度：64 command_name 否 String 参数说明：设备命令名称，在设备关联的产品模型中定义。如设备需要编解码插件来解析命令，此参数为必填项。取值范围：长度不超过128的字符串。最大长度：128 paras 是 Object 参数说明：设备执行的命令，Json格式，里面是一个个健值对，如果service_id不为空，每个健都是profile中命令的参数名（paraName）;如果service_id为空则由用户自定义命令格式。设备命令示例：{"value":"1"}，具体格式需要应用和设备约定，请求对象最大长度为256KB 最大长度：261909 expire_time 否 Integer 参数说明：物联网平台缓存命令的时长，单位秒, 平台最多缓存20条消息（即最多缓存20条PENDING状态的命令）该参数在send_strategy字段为delay时有效，默认缓存24小时，最大缓存2天。最小值：0 最大值：172800 send_strategy 是 String 参数说明：下发策略，默认缓存下发。取值范围： immediately:表示立即下发，此时expire_time无效。 delay:表示缓存下发，等数据上报或者设备上线之后下发。expire_time为0或空时，命令会默认缓存24小时。

设备接入 IOTDA 设备异步命令

设备接入 IOTDA-查询指定id的命令:响应示例

响应示例状态码： 200 OK { "device_id" : "c1224afb-e9f0-4916-8220-b6bab568e888", "command_id" : "b1224afb-e9f0-4916-8220-b6bab568e888", "service_id" : "Switch", "command_name" : "ON_OFF", "paras" : { "value" : "ON" }, "expire_time" : 0, "send_strategy" : "immediately", "created_time" : "20151212T121212Z", "status" : "DELIVERED", "result" : { "code" : 200 }, "sent_time" : "20151212T121212Z", "delivered_time" : "20151212T121212Z", "response_time" : "20151212T131312Z" }

设备接入 IOTDA 设备异步命令

设备接入 IOTDA-查询指定id的命令:URI

URI GET /v5/iot/{project_id}/devices/{device_id}/async-commands/{command_id} 表1 路径参数参数是否必选参数类型描述 project_id 是 String 参数说明：项目ID。获取方法请参见获取项目ID 。 device_id 是 String 参数说明：下发命令的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 command_id 是 String 参数说明：下发命令的命令id，用于唯一标识一个消息，在下发命令时由物联网平台分配获得。取值范围：长度不超过100，只允许字母、数字、下划线（_）、连接符（-）的组合。

设备接入 IOTDA 设备异步命令

设备接入 IOTDA-查询指定id的命令:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 device_id String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 command_id String 设备命令ID，用于唯一标识一条命令，在下发设备命令时由物联网平台分配获得。 service_id String 设备命令所属的设备服务ID，在设备关联的产品模型中定义。 command_name String 设备命令名称，在设备关联的产品模型中定义。 paras Object 设备执行的命令，Json格式，里面是一个个健值对，如果service_id不为空，每个健都是profile中命令的参数名（paraName）;如果service_id为空则由用户自定义命令格式。设备命令示例：{"value":"1"}，具体格式需要应用和设备约定。 expire_time Integer 物联网平台缓存命令的时长，单位秒。 status String 下发命令的状态。 ·PENDING表示未下发,在物联网平台缓存着 ·EXPIRED表示命令已经过期，即缓存的时间超过设定的expire_time ·SENT表示命令正在下发 ·DELIVERED表示命令已送达设备 ·SUC CES SFUL表示命令已经成功执行 ·FAILED表示命令执行失败 ·TIMEOUT表示命令下发之后，没有收到设备确认或者响应结果一定时间后超时 result Object 设备命令执行的详细结果，由设备返回，Json格式。 created_time String 命令的创建时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 sent_time String 物联网平台发送命令的时间，如果命令是立即下发，则该时间与命令创建时间一致，如果是缓存命令，则是命令实际下发的时间。"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 delivered_time String 物联网平台将命令送达到设备的时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 send_strategy String 下发策略， immediately表示立即下发，delay表示缓存起来，等数据上报或者设备上线之后下发。 response_time String 设备响应命令的时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。

设备接入 IOTDA 设备异步命令

设备接入 IOTDA-查询指定id的命令:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情。

设备接入 IOTDA 设备异步命令

云服务器内容精选

设备异步命令

7*24

备案

专业服务

退订

建议反馈

售前咨询热线