查询所有围栏

更新时间：2023-06-15 04:57:39

本文介绍查询所有围栏的 API。

接口描述

根据围栏属性条件分页查询账号下的围栏。

接口地址

GET: /v2.0/iot-01/fences/list

请求参数

参数名	类型	参数位置	是否必填	说明
bind_type	Integer	query	false	围栏绑定类型： 1：私有围栏 2：公共围栏
entity_id	String	query	false	实体 ID
page_index	Integer	query	false	分页索引，默认值 1
page_size	Integer	query	false	分页大小，默认值 50
last_row_key	Long	query	false	分页下标，page_index 与 last_id 方式二选一，last_id 只支持下一页，查询速度快，查询第一页不传；page_index 支持跳页
tag	String	query	false	维度标签，支持通过自定义维度标记对电子围栏进行分类；查询电子围栏时，支持通过维度标记筛选
coord_type_output	String	query	false	经纬度定位坐标系类型： WGS84：谷歌坐标系 GCJ02：高德 BD09LL：百度不传：国内默认高德，国外默认谷歌 </ul

返回参数

参数名	类型	说明
result	PageRes

result 说明

参数名	类型	说明
data	List	当前页数据列表
total	Long	总的查询结果数量
last_row_key	Long	当前页最后一个数据的自增 ID
last_page	Boolean	是否最后一页，true：是； false：否

data 说明

参数名	类型	说明
fence_id	Long	围栏 ID
fence_name	String	围栏名称
bind_type	Integer	围栏绑定类型： 1：私有围栏 2：公共围栏
entity_id	String	监控对象 ID
shape	String	围栏形状： circle：圆形 polygon：多边形
fence_data	FenceShapeDataRes	围栏数据点数据
warn_rule	Integer	告警规则： 1：进围栏 2：出围栏 3：进出围栏
enable	Integer	开关状态： 0：关闭 1：开启

fence_data 说明

参数名	类型	说明
circle	CircleDataRes	圆形围栏数据
polygon	List	多边形围栏数据

polygon 说明

参数名	类型	说明
lon	Double	多边形点经度
lat	Double	多边形点纬度

circle 说明

参数名	类型	说明
radius	Integer	围栏半径，单位米
lon	Double	围栏中心点经度
lat	Double	围栏中心点纬度

请求示例

GET: /v2.0/iot-01/fences/list?bind_type=1&entity_id&page_index=210&page_size=1&last_row_key

返回示例

{
    "result": {
        "last_row_key": 50004,
        "data": [
            {
                "shape": "circle",
                "fence_data": {
                    "circle": {
                        "lon": 31.218093093844796,
                        "radius": 200,
                        "lat": 121.36040929664462
                    }
                },
                "entity_id": "vdevo16245017293****",
                "bind_type": 1,
                "fence_id": 50004,
                "fence_name": "第一个私有围栏",
                "enable": 1,
                "warn_rule": 1
            }
        ],
        "last_page": false,
        "total": 213
    },
    "t": 1625217837075,
    "success": true
}

错误码

参考错误码。

上一篇删除围栏

下一篇根据围栏 ID 查询围栏