执行单个分组控制
功能介绍
执行单个分组控制
URI
POST /v1/iotfm/group-controls/{group_control_id}/execute
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_control_id |
是 |
String |
参数说明:分组控制ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数说明:用户Token。通过调用 生成Token 接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 取值范围:长度1-32768。 |
X-Instance-Id |
是 |
String |
参数说明:实例ID。通过访问智能设施云平台界面后获取,智能设施云平台资源均为实例级隔离,所有业务接口必须填写正确的实例ID才能被成功调用。 取值范围:长度8-36,只允许大小写字母、数字和-字符的组合。 |
X-Root-Zone-Id |
否 |
String |
参数说明:根区域ID。 取值范围:长度不超过24,只允许字母、数字的组合。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
参数说明:分组控制任务ID。 取值范围:长度不超过64,只允许字母、数字、以及_-字符的组合。 |
group_control_id |
String |
参数说明:分组控制ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 |
group_id |
String |
参数说明:设备分组ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 |
operator |
String |
参数说明:用户名。 取值范围:长度不超过64,只允许字母、数字、以及_-字符的组合。 |
success |
Integer |
参数说明:执行成功数量。 取值范围:1~100。 |
fail |
Integer |
参数说明:执行失败数量。 取值范围:1~100。 |
create_time |
String |
格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 |
finish_time |
String |
格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 |
executing |
Integer |
参数说明:正在执行任务数量。 取值范围:1~100。 |
task_content |
Array of GroupTaskContent objects |
参数说明:任务内容。 取值范围:数组长度不超过100。 |
参数 |
参数类型 |
描述 |
---|---|---|
product_id |
String |
参数说明:产品ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 |
action_type |
String |
参数说明:DEVICE_CONTORL:下发设备控制指令类型。当选择该类型时,必须传入device_control对象。 |
device_control |
ActionDeviceControl object |
参数说明:下发设备控制任务内容。当action_type为DEVICE_CONTROL时,该字段必填。 |
参数 |
参数类型 |
描述 |
---|---|---|
property_path |
String |
参数说明:设备属性。 取值范围:长度不超过128,只允许中文,字母、数字、以及_?/'#().,&%@$!-字符的组合。 |
property_value |
Object |
参数说明:设备属性值。 |
priority |
Integer |
参数说明:任务优先级。 取值范围:8~16。 |
end_time |
String |
参数说明:任务结束时间。 取值范围:格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 |
description |
String |
参数说明:操作说明。 取值范围:长度不超过1024,只允许中文,字母、数字、以及_?/'#().,&%@$!-字符的组合。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
执行分组控制
POST https://{endpoint}/v1/iotfm/group-controls/18ca02652bf3e84c6350ed4d
响应示例
状态码:200
OK
{ "task_id" : "18ca035e8233e84c6350ed4f", "group_id" : "18ca020ed943e84c6350ed4a", "operator" : "iotfm_echotest_admin", "success" : 0, "fail" : 1, "executing" : 0, "task_content" : [ { "product_id" : "18c9fa374df47041550bea48", "action_type" : "DEVICE_CONTROL", "device_control" : { "property_path" : "service1/switch", "property_value" : false, "priority" : 16, "description" : "打开路灯" } } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |