围栏对象管理 最后更新时间: 2021年08月26日
简介
通过以下的服务接口,开发者可以管理猎鹰地理围栏所要监测的特定终端对象。支持增加、删除及查询。
一个围栏下最多可绑定10000个监测对象(终端),超出数量请您通过工单与我们联系。
接口列表
增加监测对象
- 服务地址
URL | http://tsapi.amap.com/v1/track/geofence/terminal/bind |
请求方式 | POST |
- 请求参数
参数名 | 含义 | 规则 | 是否必填 | 缺省值 |
---|---|---|---|---|
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | 必填 | 无 |
sid | 服务唯一编号 | sid为猎鹰service唯一编号 | 必填 | 无 |
gfid | 围栏id | 指定要增加监测对象的围栏 | 必填 | 无 |
tids | 终端id | 支持一次添加多个终端tid,以“,”分割。 单次最多支持100个,如超出将只截取前100个作为输入。 | 必填 | 无 |
- 返回参数
参数名 | 含义 | 备注 | |
---|---|---|---|
errcode | 返回状态码 | 0代表成功,其他参考错误码说明 | |
errmsg | 返回状态描述 | 参考错误码说明 | |
data | |||
tids | 成功加入围栏监测的终端id | 数组格式 |
删除监测对象
- 服务地址
URL | http://tsapi.amap.com/v1/track/geofence/terminal/unbind |
请求方式 | POST |
- 请求参数
参数名 | 含义 | 规则 | 是否必填 | 缺省值 |
---|---|---|---|---|
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | 必填 | 无 |
sid | 服务唯一编号 | sid为猎鹰service唯一编号 | 必填 | 无 |
gfid | 围栏id | 指定要变更监控对象的围栏 | 必填 | 无 |
tids | 终端id | 1.支持一次传入多个终端tid,以“,”分割。 单次最多支持100个,如超出将只截取前100个作为输入。 2.可以传入 "#all" 删除所有 | 必填 | 无 |
- 返回参数
参数名 | 含义 | 备注 | |
---|---|---|---|
errcode | 返回状态码 | 0代表成功,其他参考错误码说明 | |
errmsg | 返回状态描述 | 参考错误码说明 | |
data | |||
tids | 成功移除围栏监测终端id | 数组格式;仅当入参 tids 不为 "#all" 时返回 |
查询监测对象
- 服务地址
URL | http://tsapi.amap.com/v1/track/geofence/terminal/list |
请求方式 | GET |
- 请求参数
参数名 | 含义 | 规则 | 是否必填 |
---|---|---|---|
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | 必填 |
sid | 服务唯一编号 | sid为终端所属service唯一编号 | 必填 |
gfid | 围栏的唯一标识 | 指定要查询的目标围栏 | 必填 |
page | 查询页数 | 默认1 | 可选, 默认1 |
pagesize | 每页数量 | 单页数据数量,取值 [1, 100] | 可选, 默认50 |
- 返回参数
参数名 | 含义 | 备注 | ||
---|---|---|---|---|
errcode | 返回状态码 | 0代表成功,其他参考错误码说明 | ||
errmsg | 返回状态描述 | 参考错误码说明 | ||
data | ||||
count | 数据总数量 | |||
results | 数据列表 | |||
tid | 监测对象终端id | |||
tname | 监测对象终端名称 |