服务管理 最后更新时间: 2021年01月22日
简介
本篇介绍用户如何创建一个轨迹服务。使用猎鹰对轨迹进行管理时,首先需要创建一个轨迹服务。
使用限制
服务调用量的限制请点击这里查阅。
创建服务
- 接口说明
可以通过此请求,在对应的 Key 下增加 1 个 Service,Service 增加成功后会返回 Service 的 id。每个 Key 下最多注册15个 Service。
- 服务地址
|
URL |
https://tsapi.amap.com/v1/track/service/add |
|
请求方式 |
POST |
注意:用Postman请求接口时,需要使用x-www-form-urlencoded方式传输。
- 请求参数
|
参数名 |
含义 |
规则说明 |
是否必须 |
缺省值 |
|
|---|---|---|---|---|---|
|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
必填 |
无 |
|
|
name |
服务名称 |
Service 的名字,名字在同一个 Key 下不可重复,不可为空。 命名规则:仅支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字,不能以”_”开头,最长不得超过128个字符。 |
必填 |
无 |
|
|
desc |
服务描述 |
针对此 Service 的文字描述,方便用户对 Service 进行记忆。 命名规则:仅支持中文、英文大小字母、英文下划线”_”、英文横线”-“和数字, 不能以”_”开头,最长不得超过128个字符。 |
非必填 |
无 |
|
- 返回结果
|
名称 |
含义 |
字段类型 |
|
|---|---|---|---|
|
errcode |
结果状态码 |
数值 |
|
|
errmsg |
返回结果状态码描述 |
String |
|
|
errdetail |
错误细节 |
String |
|
|
data |
|||
|
sid |
服务的唯一ID |
数值 |
|
|
name |
服务名称 |
String |
|
删除服务
- 接口说明
可以针对 Key 下面的 Service 进行删除。一旦删除 Service 将会删除 Service 内的所有信息。
- 服务地址
|
URL |
https://tsapi.amap.com/v1/track/service/delete |
|
请求方式 |
POST |
- 请求参数
|
参数名 |
含义 |
规则说明 |
是否必须 |
缺省值 |
|
|---|---|---|---|---|---|
|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
必填 |
无 |
|
|
sid |
服务的唯一编号 |
不可修改,此参数用于查找service 即便填入此参数,用户也不可修改sid。 |
必填 |
无 |
|
- 返回结果
|
名称 |
含义 |
字段类型 |
|
|---|---|---|---|
|
errcode |
结果状态码 |
数值 |
|
|
errmsg |
返回结果状态码描述 |
String |
|
|
errdetail |
错误细节 |
String |
|
修改服务
- 接口说明
用户可以对某个 Service 的名字、描述进行修改。
- 服务地址
|
URL |
https://tsapi.amap.com/v1/track/service/update |
|
请求方式 |
POST |
- 请求参数
|
参数名 |
含义 |
规则说明 |
是否必须 |
缺省值 |
|
|---|---|---|---|---|---|
|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
必填 |
无 |
|
|
sid |
服务的唯一编号 |
不可修改,此参数用于查找 Service 即便填入此参数,用户也不可修改sid。 |
必填 |
无 |
|
|
name |
服务名称 |
可以修改 若指定此字段,但是没有填写内容则会将描述清空。 若创建的时候没有描述,则会增加描述并按照用户填入信息 存储。 |
非必填 |
无 |
|
|
desc |
服务描述 |
可以修改 若指定此字段,但是没有填写内容则会将描述清空。 若创建的时候没有描述,则会增加描述并按照用户填入信息 存储。 |
非必填 |
无 |
|
- 返回结果
|
名称 |
含义 |
字段类型 |
|
|---|---|---|---|
|
errcode |
结果状态码 |
数值 |
|
|
errmsg |
返回结果状态码描述 |
String |
|
|
errdetail |
错误细节 |
String |
|
|
data |
|||
|
sid |
服务的唯一ID |
数值 |
|
|
name |
修改前的服务名称 |
String |
|
查询服务
- 接口说明
通过此接口可以查询当前账号下的所有 Service 详细信息。
- 服务地址
|
URL |
https://tsapi.amap.com/v1/track/service/list |
|
请求方式 |
GET |
- 请求参数
|
参数名 |
含义 |
规则说明 |
是否必须 |
缺省值 |
|
|---|---|---|---|---|---|
|
key |
请求服务权限标识 |
用户在高德地图官网申请Web服务API类型KEY |
必填 |
无 |
|
- 返回结果
|
名称 |
含义 |
字段类型 |
|||
|---|---|---|---|---|---|
|
errcode |
结果状态码 |
数值 |
|||
|
errmsg |
返回结果状态码描述 |
String |
|||
|
errdetail |
错误细节 |
String |
|||
|
data |
里面包含具体结果信息 |
||||
|
results |
里面包含具体信息 |
数组 |
|||
|
sid |
服务的唯一ID |
数值 |
|||
|
name |
服务的名字 |
String |
|||
|
desc |
服务的描述 |
String |
|||