创建圆形围栏

更新时间:2023-06-15 04:57:09

本文介绍创建圆形围栏的 API。

接口描述

创建一个圆形围栏,围栏绑定类型分为私有围栏和公共围栏。一个私有围栏只能监控单个对象,一个对象最多创建 100 个私有围栏,账号支持的总私有围栏个数无限制;一个公共围栏可以监控多个对象,账号总公共围栏个数限制为 1000。

接口地址

POST: /v2.0/iot-01/fences/circle

请求参数

body 说明

参数名 类型 参数位置 是否必填 说明
tag String false 维度标签,支持通过自定义维度标记对电子围栏进行分类;查询电子围栏时,支持通过维度标记筛选
fence_name String true 围栏名称
bind_type Integer true 围栏绑定类型:
  • 1:私有围栏
  • 2:公共围栏
entity_id String false 监控对象 ID ;围栏绑定类型为私有围栏时必填,公有围栏此字段无效。
radius Integer true 围栏半径,单位:米,取值范围 (0,5000]
lon Double true 围栏圆心经度
lat Double true 围栏圆心纬度
coord_type String true 经纬度定位坐标系类型:
  • WGS84:谷歌坐标系
  • GCJ02:高德
  • BD09LL:百度
warn_rule Integer true 告警规则:
  • 1:进围栏
  • 2:出围栏
  • 3:进出围栏

返回参数

参数名 类型 说明
result FenceIdRes

result 说明

参数名 类型 说明
fence_id Long 围栏 ID

请求示例

POST: /v2.0/iot-01/fences/circle
{ "tag": "family", "fence_name": "公有围栏", "bind_type": 1, "entity_id": "vdevo16245017293****", "radius": 200, "lon": "31.218093093844786", "lat": "121.36040929664465", "coord_type": "WGS84", "warn_rule": 1 }

返回示例

{ "result": { "fence_id": 51000 }, "t": 1625210821631, "success": true }

错误码

参考 错误码