文档首页/ 智能设施云平台/ API参考/ API列表/ 分组控制管理/ 分组控制/ 修改单个分组控制
更新时间：2025-08-19 GMT+08:00
查看PDF
分享

修改单个分组控制

功能介绍

修改单个分组控制

URI

PUT /v1/iotfm/group-controls/{group_control_id}

表1 路径参数

参数

是否必选

参数类型

描述

group_control_id

是

String

参数说明：分组控制ID。

取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

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，只允许字母、数字的组合。
表3 请求Body参数

参数

是否必选

参数类型

描述

control_content

是

Array of GroupControlContent objects

参数说明：任务内容。
表4 GroupControlContent

参数

是否必选

参数类型

描述

product_id

否

String

参数说明：产品ID。

取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。

action_type

否

String

参数说明：DEVICE_CONTROL：下发设备控制指令类型。当选择该类型时，必须传入device_control对象。

device_control

否

GroupControlContentAction object

参数说明：点位控制内容。当action_type为DEVICE_CONTROL时，该字段必填。
表5 GroupControlContentAction

参数

是否必选

参数类型

描述

property_path

是

String

参数说明：设备属性。

取值范围：长度不超过128，只允许字母、数字、以及_?/'#().,&%@$!-字符的组合。

property_value

是

Object

参数说明：设备属性值。

priority

否

Integer

参数说明：任务优先级。

取值范围：8~16。

contorl_time

否

Integer

控制时长

contorl_time_unit

否

String

窗口时间单位。小时-h 分钟-m 秒-s

description

否

String

参数说明：操作说明。

取值范围：长度不超过1024，只允许字母、数字、以及_?/'#().,&%@$!-字符的组合。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

group_id

String

参数说明：分组ID。

取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。

group_control_id

String

参数说明：分组控制ID。

取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。

control_content

Array of GroupControlContent objects

参数说明：控制内容。

control_name

String

参数说明：分组控制名称。

取值范围：长度不超过64，只允许中文、字母、数字、以及_-字符的组合。

create_time

String

格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。

update_time

String

格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。
表7 GroupControlContent

参数

参数类型

描述

product_id

String

参数说明：产品ID。

取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。

action_type

String

参数说明：DEVICE_CONTROL：下发设备控制指令类型。当选择该类型时，必须传入device_control对象。

device_control

GroupControlContentAction object

参数说明：点位控制内容。当action_type为DEVICE_CONTROL时，该字段必填。
表8 GroupControlContentAction

参数

参数类型

描述

property_path

String

参数说明：设备属性。

取值范围：长度不超过128，只允许字母、数字、以及_?/'#().,&%@$!-字符的组合。

property_value

Object

参数说明：设备属性值。

priority

Integer

参数说明：任务优先级。

取值范围：8~16。

contorl_time

Integer

控制时长

contorl_time_unit

String

窗口时间单位。小时-h 分钟-m 秒-s

description

String

参数说明：操作说明。

取值范围：长度不超过1024，只允许字母、数字、以及_?/'#().,&%@$!-字符的组合。

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

修改分组控制

PUT https://{endpoint}/v1/iotfm/group-controls/18ca02652bf3e84c6350ed4d

{
  "control_content" : [ {
    "product_id" : "18c9fa374df47041550bea48",
    "action_type" : "DEVICE_CONTROL",
    "device_control" : {
      "property_path" : "service1/switch",
      "property_value" : false,
      "priority" : 16,
      "description" : "打开路灯"
    }
  } ]
}

响应示例

状态码：200

OK

{
  "group_id" : "18ca020ed943e84c6350ed4a",
  "group_control_id" : "18ca02652bf3e84c6350ed4d",
  "control_content" : [ {
    "product_id" : "18c9fa374df47041550bea48",
    "action_type" : "DEVICE_CONTROL",
    "device_control" : {
      "property_path" : "service1/switch",
      "property_value" : false,
      "priority" : 16,
      "description" : "打开路灯"
    }
  } ],
  "control_name" : "路灯分组控制"
}

状态码

状态码

描述

200

OK

400

Bad Request
父主题： 分组控制

相关文档