示例中心
功能在线体验
控制台
您现在的位置: 开发 > 猎鹰轨迹服务 > 开发指南 > API文档 > 终端管理 >

高德 开发 猎鹰轨迹服务 开发指南 API文档 终端管理

更新时间:2018年08月31日

简介

本篇介绍终端管理相关内容,任何的移动设备、车辆都可以被视为一个终端。

终端管理类接口主要实现:terminal 的创建、更新、删除、查询。例如:添加一辆车、删除一辆车、更新车辆属性等。

用量限制

 服务调用量的限制请点击这里查阅。  

创建终端

  • 接口说明

每次调用此接口,可以在指定 Service 下创建1个终端,默认最大支持创建100000个。

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/add

请求方式

POST

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

必填

sid

服务的唯一编号

 用户希望在哪个 Service下创建终端,填入对应 Service 的id 

必填 

无 

name

服务名称

希望创建终端的名字,同一个service下不可出现名字相同的终端,不可为空

命名规则:仅支持中文、英文大小字母、英文下划线"_"、英文横线"-"和数字

最长不得超过128字符, 不能以"_"开头

需要说明,此字段将作为日后可视化管理的显示字段,不可修改 

必填

无  

desc

服务描述

针对增加终端的可读性描述

命名规则:仅支持中文、英文大小字母、英文下划线"_"、英文横线"-"和数字

最长不得超过128字符,不能以"_"开头 

非必填 

无  

 props 

自定义字段

此字段为用户针对终端的自定义字段,若想使用必须先在“针对终端自定义字段”中进行创建字段。

此中必须为一个json格式对象,需要按照定义的类型上传数据,例如定义为int,则仅上传数字。

仅支持中文、英文大小字母、英文下划线"_"、英文横线"-"、数字和”.”,,不允许"_"开头。

内容最长不得超过128字符 

非必填  

无   

  • 返回结果参数说明

名称

含义

字段类型

errcode

结果状态码

数值 

errmsg

返回结果状态码描述

String

errdetail

错误细节

String

data




sid

终端所属service的id

数值


tid

终端id

数值 


name

终端的名称

String 

删除终端

  • 接口说明

用户可以通过指定 Service 的sid 与终端 id 对终端进行删除操作。开发者不可通过接口获取任何已删除终端的数据信息。

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/delete

请求方式

POST

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

必填

sid

服务的唯一编号

创建猎鹰轨迹service后获取到的id

必填 

无 

tid

终端id 

希望删除终端的id

必填

无  

  •  返回结果 

名称

含义

字段类型

errcode

结果状态码

数值 

errmsg

返回结果状态码描述

String

errdetail

错误细节

String

修改终端

  • 接口说明

 希望对终端的属性进行修改调整的时候,需要调用此接口。 

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/update

请求方式

POST

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

必填

sid

服务的唯一编号

service id,用于查找被修改参数使用

必填 

无 

tid

终端

id

希望修改的终端设备id

必填  

无   

name

终端名字

该字段是可修改字段

非必填

无  

desc

服务描述

该字段是可修改字段

如果需要更新描述,需要在此字段填入内容;若指定此字段,但是没有填写内容则会将原来描述清空。

最长不得超过128字符 

非必填 

无  

props 

自定义字段

该字段是可修改字段

针对终端自定义的内容,可以进行更新,但是内部必须为一个json对象,若指定某字段,但是没有填写内容则会将原来描述清空;例如json中有两个字段,a和b,如果只更新a字段不更新b字段请在json中只填写a字段,不要填写b字段(若填写b字段但不赋值则b字段会被复写清空)。

仅支持中文、英文大小字母、英文下划线"_"、英文横线"-"、数字和”.”,内容最长不得超过128字符,,不允许"_"开头。 

非必填 

无   

  •  返回结果 

名称

含义

字段类型

说明

errcode

结果状态码

数值 


errmsg

返回结果状态码描述

String


errdetail

错误细节

String


查询终端

  • 接口说明

查询终端接口包含两个功能:

  1. 查询指定 service 中符合条件的终端及相关信息;
  2. 直接查询指定终端及相关信息;

请注意,该接口需要使用Get形式请求。

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/list

请求方式

GET

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

必填

sid

查询的服务ID

终端所属serivce的id

必填

tid

查询的设备ID

终端id

非必填

name

查询的设备名称

若同时指定了tid和name则以tid为准

非必填

page

当前显示页数

每页显示50条数据

1

  •  返回结果 

名称

含义

字段类型

说明

errcode

结果状态码

数值 


errmsg

返回结果状态码描述

String


errdetail

错误细节

String


data

里面包含具体结果信息


count

返回的数据条数

数值



results

里面包含具体信息

数组




name

服务的唯一ID

数值




tid

服务的名字

String




desc

服务的描述

String




createtime

此终端创立时间,用Unix时间戳表示,精准到毫秒 

数值




locatetime

此设备最后一次的定位时间点,用Unix时间戳表示

若一直未上传轨迹点则返回null 

数值 




props

下方为用户自定义字段 

对象





<key-value-terminal>

开发者针对终端自定义的字段,返回此字段和内容。

key代表名字

value代表内容 

用户自定义



示例中心 功能
在线体验
常见问题