更新时间:2025-08-19 GMT+08:00
分享

查询边缘设备控制记录

功能介绍

查询边缘设备控制记录

URI

POST /v1/iotfm/edge/control/records

表1 Query参数

参数

是否必选

参数类型

描述

marker

String

参数说明:上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的数据记录ID也会越大。若填写marker,则本次只查询记录ID小于marker的数据记录。若不填写,则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据,则每次查询时必须填写上一次查询响应中的marker值。

取值范围:长度固定24,只允许大小写字母、数组的组合。

limit

Integer

参数说明:分页查询时每页显示的记录数。

取值范围:默认值为10,取值范围为1-50的整数。

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,只允许字母、数字的组合。

表3 请求Body参数

参数

是否必选

参数类型

描述

device_id_list

Array of strings

设备列表id

group_task_id_list

Array of strings

分组控制任务id列表

control_id

String

对应持续控制id

schedule_id

String

执行计划id

control_type

String

控制类型(持续控制、持续控制释放、持续控制、持续控制释放、定时控制、定时控制释放)

priority

Integer

控制优先级

start_time

String

开始时间,格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。

end_time

String

结束时间,格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。

action_result

String

执行结果

operator

String

操作者

property_path_list

Array of strings

设备属性路径列表

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

表5 响应Body参数

参数

参数类型

描述

control_records

Array of ControlRecordRsp objects

设备控制记录结果

page

Page object

分页信息

表6 ControlRecordRsp

参数

参数类型

描述

instance_id

String

实例ID

group_task_id

String

分组控制任务ID

control_id

String

控制ID,用于非定时类控制

schedule_id

String

计划表ID,当前用于定时控制、定时控制释放

device_id

String

设备ID

device_name

String

设备名称

control_type

String

控制类型

priority

Integer

控制优先级

last_priority

Array of integers

上一次控制优先级,仅强制控制场景存在该字段。

content_display

String

执行内容(前台展示)

content

String

执行内容

operator

String

操作者

property_path

String

属性路径

operate_reason

String

操作原因

action_result

String

执行结果

error_reason

String

错误原因

start_time

String

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

end_time

String

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

表7 Page

参数

参数类型

描述

count

Long

参数说明:本次分页查询结果中,获取的记录总数。

marker

String

参数说明:本次分页查询结果中最后一条记录的ID,可在下一次分页查询时使用。

取值范围:长度0-64。

状态码:400

表8 响应Header参数

参数

参数类型

描述

X-Request-Id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数说明:错误码。

取值范围:长度8-36。

error_msg

String

参数说明:错误描述。

取值范围:长度2-512。

请求示例

响应示例

状态码

状态码

描述

200

查询控制列表响应体

400

Error response

500

Internal Server Error

相关文档