查询定时控制列表

功能介绍

查询定时控制列表

URI

GET /v1/iotfm/edge/control/schedules

表1 Query参数
参数	是否必选	参数类型	描述
mgmt_zone_id	否	String	参数说明：管理项目ID。取值范围：长度不超过24，只允许字母、数字的组合。
name	否	String	参数说明：定时控制名称。取值范围：长度不超过64，只允许中文、字母、数字、以及_-字符的组合。
scene_id	否	String	参数说明：场景ID。取值范围：长度不超过24，只允许字母、数字的组合。
execute_status	否	String	参数说明：执行状态。取值范围：await：待执行、executing：执行中、completed：已完成、abnormal：执行异常。
limit	否	Integer	参数说明：分页查询时每页显示的记录数。取值范围：默认值为10，取值范围为1-50的整数。
marker	否	String	参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。取值范围：长度固定24，只允许大小写字母、数组的组合。
offset	否	Integer	参数说明：表示从marker后偏移offset条记录开始查询。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。取值范围：默认为0，取值范围为0-500的整数。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
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，只允许字母、数字的组合。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
schedule_controls	Array of ScheduleControl objects	参数说明：定时控制列表。
page	Page object	查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大ID。

表4 ScheduleControl
参数	参数类型	描述
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	参数说明：定时控制的执行模式。取值范围： once：单次执行 loop：循环执行。
loop_mode	String	参数说明：定时控制的循环模式，当execute_mode为loop时需要填入此参数。取值范围： daily：每天循环 weekly：周循环 scene：场景化循环。
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	参数说明：执行状态。取值范围： await：待执行 executing：执行中 completed：已完成 abnormal：执行异常
send_status	String	参数说明：下发状态。取值范围： success：下发成功 failed：下发失败 waited：待下发
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'。

表5 OnceCalendar
参数	参数类型	描述
start_date	String	参数说明：开始日期，格式：yyyy-MM-dd。
end_date	String	参数说明：结束日期，格式：yyyy-MM-dd。

表6 SceneCalendar
参数	参数类型	描述
calendar_id	String	参数说明：日历ID。取值范围：长度不超过24，只允许字母、数字的组合。
work_type	String	参数说明：日期所属工休类型。取值范围： workday：工作日。 holiday：休息日。

表7 ExecuteContent
参数	参数类型	描述
product_id	String	参数说明：产品ID。取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。
devices	Array of strings	参数说明：设备ID列表。取值范围：长度不超过128，只允许字母、数字、以及_-字符的组合。
device_properties	Array of DeviceProperty objects	参数说明：设备属性列表。
device_execute_spans	Array of DeviceExecuteSpan objects	参数说明：设备执行时间列表。

表8 DeviceProperty
参数	参数类型	描述
property_path	String	参数说明：设备属性。取值范围：长度不超过128，只允许中文、字母、数字以及_?/'#().,&%@!-字符的组合。
property_value	Object	参数说明：设备属性值。

表9 DeviceExecuteSpan
参数	参数类型	描述
start	String	参数说明：开始时间，格式：HH:mm:ss。
end	String	参数说明：结束时间，格式：HH:mm:ss。

**表10** Page
参数	参数类型	描述
count	Long	参数说明：本次分页查询结果中，获取的记录总数。
marker	String	参数说明：本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。取值范围：长度0-64。

状态码：400

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	参数说明：错误码。取值范围：长度8-36。
error_msg	String	参数说明：错误描述。取值范围：长度2-512。