查询分组控制列表
功能介绍
查询分组控制列表
URI
GET /v1/iotfm/group-controls
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
control_name |
否 |
String |
参数说明：分组控制名称。 取值范围：长度不超过64，只允许中文、字母、数字、以及_-字符的组合。 |
|
limit |
否 |
Integer |
参数说明：分页查询时每页显示的记录数，默认值为10。 取值范围：1-50的整数。 |
|
marker |
否 |
String |
参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 取值范围：长度24，只允许大小写字母、数字的组合。 |
|
offset |
否 |
Integer |
参数说明：表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 取值范围：0-500的整数。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
group_controls |
Array of CreateGroupControlsRsp objects |
参数说明：分组控制列表。 取值范围：数组长度不超过50。 |
|
page |
Page object |
查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大Id。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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'"。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
product_id |
String |
参数说明：产品ID。 取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。 |
|
action_type |
String |
参数说明：DEVICE_CONTROL：下发设备控制指令类型。当选择该类型时，必须传入device_control对象。 |
|
device_control |
GroupControlContentAction object |
参数说明：点位控制内容。当action_type为DEVICE_CONTROL时，该字段必填。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
property_path |
String |
参数说明：设备属性。 取值范围：长度不超过128，只允许字母、数字、以及_?/'#().,&%@$!-字符的组合。 |
|
property_value |
Object |
参数说明：设备属性值。 |
|
priority |
Integer |
参数说明：任务优先级。 取值范围：8~16。 |
|
contorl_time |
Integer |
控制时长 |
|
contorl_time_unit |
String |
窗口时间单位。小时-h 分钟-m 秒-s |
|
description |
String |
参数说明：操作说明。 取值范围：长度不超过1024，只允许字母、数字、以及_?/'#().,&%@$!-字符的组合。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Long |
参数说明：本次分页查询结果中，获取的记录总数。 取值范围：0-9223372036854775807的整数。 |
|
marker |
String |
参数说明：本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 取值范围：长度不超过64的字符串。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
查询分组控制列表
GET https://{endpoint}/v1/iotfm/group-controls?offset=0&limit=10
响应示例
状态码：200
OK
{
"group_controls" : [ {
"group_id" : "18ca020ed943e84c6350ed4a",
"group_control_id" : "18ca02652bf3e84c6350ed4d",
"control_content" : [ {
"product_id" : "18c9fa374df47041550bea48",
"action_type" : "DEVICE_CONTROL",
"device_control" : {
"property_path" : "service1/switch",
"property_value" : true,
"priority" : 16,
"description" : "打开路灯"
}
} ],
"control_name" : "路灯分组控制",
"create_time" : "2024-12-27T01:52:49.999Z",
"update_time" : "2024-11-27T01:52:49.999Z"
} ],
"page" : {
"count" : 1,
"marker" : "18ca02652c03e84c6350ed4e"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
