修改定时控制
功能介绍
修改定时控制
URI
PUT /v1/iotfm/edge/control/schedules/{schedule_control_id}
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| schedule_control_id | 是 | String | 参数说明:定时控制ID。 取值范围:长度24,只允许字母、数字的组合。 | 
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数说明:用户Token。通过调用 生成Token 接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 | 
| X-Instance-Id | 是 | String | 参数说明:实例ID。通过访问智能设施云平台界面后获取,智能设施云平台资源均为实例级隔离,所有业务接口必须填写正确的实例ID才能被成功调用。 取值范围:长度8-36,只允许大小写字母、数字和-字符的组合。 | 
| X-Root-Zone-Id | 否 | String | 参数说明:项目ID。 取值范围:长度不超过24,只允许字母、数字的组合。 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| name | 否 | String | 参数说明:定时控制名称。 取值范围:长度不超过64,只允许中文、字母、数字、以及_-字符的组合。 | 
| description | 否 | String | 参数说明:定时控制描述。 取值范围:长度不超过500,只允许中文、字母、数字、以及_-,,!!。.字符的组合。 | 
| enabled | 否 | Boolean | 参数说明:启用状态。 取值范围:true:启用,false:停用。 | 
| execute_contents | 否 | Array of ExecuteContent objects | 参数说明:执行内容。 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| product_id | 是 | String | 参数说明:产品ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 | 
| devices | 是 | Array of strings | 参数说明:设备ID列表。 取值范围:长度不超过128,只允许字母、数字、以及_-字符的组合。 | 
| device_properties | 是 | Array of DeviceProperty objects | 参数说明:设备属性列表。 | 
| device_execute_spans | 是 | Array of DeviceExecuteSpan objects | 参数说明:设备执行时间列表。 | 
响应参数
状态码:200
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| schedule_id | String | 参数说明:定制控制ID,创建定制控制时由设施云平台分配获得。 取值范围:长度24,只允许字母、数字的组合。 | 
| name | String | 参数说明:定时控制名称。 取值范围:长度不超过64,只允许中文、字母、数字、以及_-字符的组合。 | 
| description | String | 参数说明:定时控制描述。 取值范围:长度不超过500,只允许中文、字母、数字、以及_-,,!!。.字符的组合。 | 
| scene_id | String | 参数说明:场景ID。 取值范围:长度24,只允许字母、数字的组合。 | 
| control_level | Integer | 参数说明:控制级别。 取值范围:范围是10-16,数值越小,优先级越高。 | 
| mgmt_zone_id | String | 参数说明:管理空间ID。 取值范围:长度不超过24,只允许字母、数字的组合。 | 
| enabled | Boolean | 参数说明:启用状态。 取值范围:true:启用,false:停用。 | 
| execute_mode | String | 参数说明:定时控制的执行模式。 取值范围: | 
| loop_mode | String | 参数说明:定时控制的循环模式,当execute_mode为loop时需要填入此参数。 取值范围: | 
| once_calendar | OnceCalendar object | 参数说明:单次执行日历,当execute_mode为once时需要填入此参数。 | 
| week_calendars | Array of integers | 参数说明:周循环日历,当loop_mode为weekly时需要填入此参数。 | 
| scene_calendar | SceneCalendar object | 场景化日历,当loop_mode为scene时需要填入此参数。 | 
| execute_contents | Array of ExecuteContent objects | 参数说明:执行内容。 | 
| execute_status | String | 参数说明:执行状态。 取值范围: | 
| send_status | String | 参数说明:下发状态。 取值范围: | 
| end_time | String | 参数说明:结束时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 | 
| send_time | String | 参数说明:下发时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 | 
| last_execute_time | String | 参数说明:上次执行时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 | 
| next_execute_time | String | 参数说明:下次执行时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 | 
| create_time | String | 参数说明:定时控制创建时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 | 
| update_time | String | 参数说明:定时控制更新时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| start_date | String | 参数说明:开始日期,格式:yyyy-MM-dd。 | 
| end_date | String | 参数说明:结束日期,格式:yyyy-MM-dd。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| calendar_id | String | 参数说明:日历ID。 取值范围:长度不超过24,只允许字母、数字的组合。 | 
| work_type | String | 参数说明:日期所属工休类型。 取值范围: | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| product_id | String | 参数说明:产品ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 | 
| devices | Array of strings | 参数说明:设备ID列表。 取值范围:长度不超过128,只允许字母、数字、以及_-字符的组合。 | 
| device_properties | Array of DeviceProperty objects | 参数说明:设备属性列表。 | 
| device_execute_spans | Array of DeviceExecuteSpan objects | 参数说明:设备执行时间列表。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| property_path | String | 参数说明:设备属性。 取值范围:长度不超过128,只允许中文、字母、数字以及_?/'#().,&%@!-字符的组合。 | 
| property_value | Object | 参数说明:设备属性值。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| start | String | 参数说明:开始时间,格式:HH:mm:ss。 | 
| end | String | 参数说明:结束时间,格式:HH:mm:ss。 | 
状态码:400
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 参数说明:错误码。 取值范围:长度8-36。 | 
| error_msg | String | 参数说明:错误描述。 取值范围:长度2-512。 | 
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 | 
|---|---|
| 200 | OK | 
| 400 | Bad Request | 
 
  