轨迹围栏管理最后更新时间: 2021年09月08日

简介

猎鹰地理围栏是一个虚拟的空间围栏，可以帮助开发者检测人或物何时进入或离开预定义区域，并支持实时报警功能。

适用于追踪观测某对象是否在预期的空间范围内。

一个service下最多可创建1000个围栏，更大数量的需求请您通过工单与我们联系。

接口列表

接口名称	功能说明
v1/track/geofence/add/circle	创建圆形围栏
v1/track/geofence/add/polygon	创建多边形围栏
v1/track/geofence/add/polyline	创建线形围栏
v1/track/geofence/add/district	创建行政区划围栏
v1/track/geofence/update/circle	更新圆形围栏
v1/track/geofence/update/polygon	更新多边形围栏
v1/track/geofence/update/polyline	更新线形围栏
v1/track/geofence/update/district	更新行政区划围栏
v1/track/geofence/delete	删除围栏
v1/track/geofence/list	查询围栏

创建圆形围栏

服务地址

URL	https://tsapi.amap.com/v1/track/geofence/add/circle
请求方式	POST

请求参数

参数名	含义	规则	是否必填	缺省值
key	高德key	用户在高德地图官网申请Web服务API类型Key	必填	无
sid	服务唯一编号	sid为猎鹰service唯一编号	必填	无
name	围栏名称	在同一个 sid 下不可重复，不可为空。支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	必填	无
desc	围栏描述	支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	否	无
center	围栏中心点坐标	格式X,Y	必填	无
radius	围栏半径	单位：米，整数，取值范[1,50000]	必填	无

返回参数

参数名		参数含义	备注
errcode		返回状态码	0代表成功，其他参考错误码说明
errmsg		返回状态描述	参考错误码说明
data
	gfid	围栏的唯一标识	由系统自动生成，按正整数递增

创建多边形围栏

服务地址

URL	https://tsapi.amap.com/v1/track/geofence/add/polygon
请求方式	POST

请求参数

请求参数	含义	规则	是否必填	缺省值
key	高德Key	用户在高德地图官网申请Web服务API类型Key	必填	无
sid	服务唯一编号	sid为猎鹰service唯一编号	必填	无
name	围栏名称	在同一个 sid 下不可重复，不可为空。支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	必填	无
desc	围栏描述	支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	否	无
points	多边形顶点坐标	格式 X1,Y1;X2,Y2;… 顶点顺序可按顺时针或逆时针排列； 1. 普通地理围栏：顶点个数在3-100个之间，外接矩形面积<100平方公里； 2. 大范围地理围栏：顶点个数在3-100个之间，外接矩形面积小于1000平方公里，请您通过工单与我们联系。	必填	无

返回参数

参数名		含义	备注
errcode		返回状态码	0代表成功，其他参考错误码说明
errmsg		返回状态描述	参考错误码说明
data
	gfid	围栏的唯一标识	由系统自动生成，按正整数递增

创建线形围栏

服务地址

URL	https://tsapi.amap.com/v1/track/geofence/add/polyline
请求方式	POST

请求参数

参数名	含义	规则	是否必填	缺省值
key	高德Key	用户在高德地图官网申请Web服务API类型Key	必填	无
sid	服务唯一编号	sid为猎鹰service唯一编号	必填	无
name	围栏名称	在同一个 sid 下不可重复，不可为空。支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	必填	无
desc	围栏描述	支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	否	无
points	线上各点坐标	格式 X1,Y1;X2,Y2;… 线路总长度<500KM，坐标点个数取值范围 [2，100]，超出范围请您通过工单与我们联系。	必填	无
bufferradius	沿线偏移距离	单位：米取值范围 [1，300]	必填	无

返回参数

参数名		含义	备注
errcode		返回状态码	0代表成功，其他参考错误码说明
errmsg		返回状态描述	参考错误码说明
data
	gfid	围栏的唯一标识	由系统自动生成，按正整数递增

创建行政区划围栏

服务地址

URL	https://tsapi.amap.com/v1/track/geofence/add/district
服务地址	POST

请求参数

参数名	含义	规则	是否必填	缺省值
key	高德Key	用户在高德地图官网申请Web服务API类型Key	必填	无
sid	服务唯一编号	sid为猎鹰service唯一编号	必填	无
name	围栏名称	在同一个 sid 下不可重复，不可为空。支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	必填	无
desc	围栏描述	支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	否	无
adcode	行政区划编码	参考行政区划编码表	必填	无

返回参数

参数名		含义	备注
errcode		返回状态码	0代表成功，其他参考错误码说明
errmsg		返回状态描述	参考错误码说明
data
	gfid	围栏的唯一标识	由系统自动生成，按正整数递增

更新圆形围栏

服务地址

URL	https://tsapi.amap.com/v1/track/geofence/update/circle
请求方式	POST

请求参数

参数名	含义	规则	是否必填	缺省值
key	高德Key	用户在高德地图官网申请Web服务API类型Key	必填	无
sid	服务唯一编号	sid为猎鹰service唯一编号	必填	无
gfid	围栏id	围栏唯一标识，指定要更新的围栏	必填	无
name	围栏名称	在同一个 sid 下不可重复，不可为空。支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	必填	无
desc	围栏描述	支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	否	无
center	围栏中心点坐标	格式X,Y	必填	无
radius	围栏半径	单位：米，整数，取值范[1,50000]	必填	无

返回参数

参数名	含义	备注
errcode	返回状态码	0代表成功，其他参考错误码说明
errmsg	返回状态描述	参考错误码说明

更新多边形围栏

服务地址

URL	https://tsapi.amap.com/v1/track/geofence/update/polygon
请求方式	POST

请求参数

参数名	含义	规则	是否必填	缺省值
key	高德Key	用户在高德地图官网申请Web服务API类型Key	必填	无
sid	服务唯一编号	sid为猎鹰service唯一编号	必填	无
gfid	围栏id	围栏唯一标识，指定要更新的围栏	必填	无
name	围栏名称	在同一个 sid 下不可重复，不可为空。支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	必填	无
desc	围栏描述	支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	否	无
points	多边形顶点坐标	格式 X1,Y1;X2,Y2;… 顶点顺序可按顺时针或逆时针排列； 1. 普通地理围栏：顶点个数在3-100个之间，外接矩形面积<100平方公里。 2. 大范围地理围栏：顶点个数在3-100个之间，外接矩形面积小于1000平方公里,请您通过工单与我们联系。	必填	无

返回参数

参数名	含义	备注
errcode	返回状态码	0代表成功，其他参考错误码说明
errmsg	返回状态描述	参考错误码说明

更新线形围栏

服务地址

URL	https://tsapi.amap.com/v1/track/geofence/update/polyline
请求方式	POST

请求参数

参数名	含义	规则	是否必填	缺省值
key	高德Key	用户在高德地图官网申请Web服务API类型Key	必填	无
sid	服务唯一编号	sid为猎鹰service唯一编号	必填	无
gfid	围栏id	围栏唯一标识，指定要更新的围栏	必填	无
name	围栏名称	在同一个 sid 下不可重复，不可为空。支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	必填	无
desc	围栏描述	支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	否	无
points	线上各点坐标	格式 X1,Y1;X2,Y2;… 线路总长度<500KM，坐标点个数取值范围 [2，100]，超出范围请您通过工单与我们联系。	必填	无
bufferradius	沿线偏移距离	单位：米取值范围 [1，300]	必填	无

返回参数

参数名	含义	备注
errcode	返回状态码	0代表成功，其他参考错误码说明
errmsg	返回状态描述	参考错误码说明

更新行政区划围栏

服务地址

URL	https://tsapi.amap.com/v1/track/geofence/update/district
请求方式	POST

请求参数

参数名	含义	规则	是否必填	缺省值
key	高德Key	用户在高德地图官网申请Web服务API类型Key	必填	无
sid	服务唯一编号	sid为猎鹰service唯一编号	必填	无
gfid	围栏id	围栏唯一标识，指定要更新的围栏	必填	无
name	围栏名称	在同一个 sid 下不可重复，不可为空。支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	必填	无
desc	围栏描述	支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字，长度不大于128个字符	否	无
adcode	行政区划编码	参考行政区划编码表	必填	无

返回参数

参数名	含义	备注
errcode	返回状态码	0代表成功，其他参考错误码说明
errmsg	返回状态描述	参考错误码说明

删除围栏

服务地址

URL	https://tsapi.amap.com/v1/track/geofence/delete
请求方式	POST

请求参数

参数名

含义

规则

是否必填

key

高德Key

用户在高德地图官网申请Web服务API类型Key

必填

sid

服务唯一编号

sid为终端所属service唯一编号

必填

gfids

围栏的唯一标识

1.支持一次传入多个，以”,”分割；单次最多支持100个，如超出将只截取前100个作为输入；

2.可以传入 “#all” 删除所有。

必填

返回参数

参数名		含义	备注
errcode		返回状态码	0代表成功，其他参考错误码说明
errmsg		返回状态描述	参考错误码说明
data
	gfids	删除成功的 gfid 列表	数组格式；仅当入参 gfids 不为 “#all” 时返回

查询围栏

服务地址

URL	https://tsapi.amap.com/v1/track/geofence/list
请求方式	GET

请求参数

参数名	含义	规则	是否必填
key	高德Key	用户在高德地图官网申请Web服务API类型Key	必填
sid	服务唯一编号	sid为终端所属service唯一编号	必填
outputshape	是否返回形状信息	1：是 0：否	可选，默认0
gfids	围栏的唯一标识	支持一次传入多个，以”,”分割；单次最多支持100个，如超出将只截取前100个作为输入。	否；如传入，则只返回由 gfids 所指定的围栏，不分页（忽略 page 和 pagesize 参数）；如不传，则分页返回所有围栏；
page	查询页数	默认1	可选，默认1
pagesize	每页围栏数量	单页数据数量，取值 [1, 100]	可选，默认50

返回参数

参数名				含义	备注
errcode				返回状态码	0代表成功，其他参考错误码说明
errmsg				返回状态描述	参考错误码说明
data
	count			数据总数量
	results			数据列表
		gfid		围栏id
		name		围栏名称
		desc		描述信息	仅当描述信息不为空时返回
		shape		围栏形状信息	仅当请求参数 outputshape 为 1 时返回
			points	坐标点	格式”x1,y1;x2,y2;…”，仅当围栏为多边形、线形时返回
			bufferradius	沿线偏移距离	仅在线形围栏时返回
		createtime		围栏创建时间	该围栏创建成功的时间，时间戳格式，精确到ms
		modifytime		围栏修改时间	该围栏最近一次更新的时间，时间戳格式，精确到ms