轨迹云 / 开发指南 / 终端管理

概述

提供服务终端管理功能，支持终端创建、删除、修改、列表的能力。

创建终端

请求URL

URL：https://apis.map.qq.com/tracks/entity/create
Method：POST
Header：Content-Type:application/json


请求参数

参数名 类型 必填 说明
key string 必 开发密钥（Key）
service_id string 必 服务id，要添加终端的轨迹服务id，需验证轨迹服务是否存在
entity_id string 选 终端唯一标识，同一个service下不可重复，缺省时系统将自动生成以"sys_"为前缀的随机字符串，字符长度限制<=64个字节
entity_name string 必 终端名称，不可为空
支持中文、英文大小字母、数字
特殊字符仅支持英文下划线"_"、英文横线"-",且不能以""开头，
长度不得超过128个字符。
entity_desc string 选 终端描述，可为空
支持中文、英文大小字母、数字
特殊字符仅支持英文下划线"_"、英文横线"-"
长度不得超过128个字符。
entity_fields object 选 自定义字段，需为该轨迹服务下创建的终端自定义字段 ，自定义内容大小不得超过2k
Json样例：
entity_fields:{
“city”:“北京”,
“count”:1285
}

响应结果

名称 类型 是否必须 说明
status string 必 状态码，0代表成功，其他为失败
message string 必 请求ID，用于问题排查
request_id string 必 对status值的描述
result object 必 返回结果
service_id string 必 服务ID
entity_id string 必 终端ID
entity_name string 必 终端名称

请求示例

//URL：https://apis.map.qq.com/tracks/entity/create
//Method：POST
//请求头：content-type:application/json
{
    "key":"您的KEY",
    "service_id":"6268b733bd8a428832b3e818",
    "entity_id":"entity-002",
    "entity_name":"test-002",
    "entity_desc":"测试",
    "entity_fields":{
        "city":"北京市"
    }
}

响应示例

{
    "status": 0,
    "message": "OK",
    "request_id": "7877b605-e582-497a-b830-5b56d0976c5e-13f96c457221da18",
    "result": {
        "service_id": "6268b733bd8a428832b3e818",
        "entity_id": "entity-002",
        "entity_name": "test-002"
    }
}

修改终端

请求URL

URL：https://apis.map.qq.com/tracks/entity/update
Method：POST
Header：Content-Type:application/json


请求参数

参数名 类型 必填 说明
key string 必 开发密钥（Key）
service_id string 必 服务id，要添加终端的轨迹服务id，需验证轨迹服务是否存在
entity_id string 必 要修改的终端唯一标识
entity_name string 必 终端名称，不可为空
支持中文、英文大小字母、数字
特殊字符仅支持英文下划线"_"、英文横线"-",且不能以""开头，
长度不得超过128个字符。
entity_desc string 选 终端描述，可为空
支持中文、英文大小字母、数字
特殊字符仅支持英文下划线"_"、英文横线"-"
长度不得超过128个字符。
entity_fields object 选 自定义字段，需为该轨迹服务下创建的终端自定义字段
Json样例：
entity_fields:{
“city”:“北京”,
“count”:1285
}

响应结果

名称 类型 是否必须 说明
status string 必 状态码，0代表成功，其他为失败
message string 必 对status值的描述
request_id string 必 请求ID，用于问题排查

请求示例

//URL：https://apis.map.qq.com/tracks/entity/update
//Method：POST
//请求头：content-type:application/json
{
	"key":"您的KEY",
	"service_id":"6268b733bd8a428832b3e818",
	"entity_id":"entityid001",
	"entity_name":"终端名称",
	"entity_desc":"描述内容",
	"entity_fields":{
		"city":"北京市"
	}
}

响应示例

{
    "status": 0,
    "message": "OK",
    "request_id": "e642da34-3325-4cc7-bb69-6a2122b19e44-5c0d3ce185d17cd2"
}

删除终端

请求URL

URL：https://apis.map.qq.com/tracks/entity/delete
Method：POST
Header：Content-Type:application/json


请求参数

参数名 类型 必填 说明
key string 必 开发密钥（Key）
service_id string 必 服务id，要添加终端的轨迹服务id，需验证轨迹服务是否存在
entity_id string 必 要删除的终端id

响应结果

名称 类型 是否必须 说明
status string 必 状态码，0代表成功，其他为失败
message string 必 对status值的描述
request_id string 必 请求ID，用于问题排查

请求示例

//URL：https://apis.map.qq.com/tracks/entity_field/delete
//Method：POST
//请求头：content-type:application/json
{
    "key":"您的KEY",
    "service_id":"6268b733bd8a428832b3e818",
    "entity_id":"entityid_001"
}

响应示例

{
    "status": 0,
    "message": "OK",
    "request_id": "6841cbc5-21c4-43db-896b-2378da12aea5-61d5d815f880bdf8"
}

终端列表

通过本接口翻页可遍历全表数据，可用于显示数据列表 或 数据导出。

请求URL

URL：https://apis.map.qq.com/tracks/entity/list
Method：GET


请求参数

参数名 说明 必填 示例
key 是 开发密钥（Key） key=您的KEY
service_id 是 轨迹服务ID service_id=6268b733bd8a428832b3e818
page_index 否 页码，从1开始，超过最大页数将返回空数组。 page_index=2
page_size 否 每页条数，默认10条，取值范围1-200 page_size=20
output 否 返回格式：支持JSON/JSONP，默认JSON output=JSONP
callback 否 JSONP方式回调函数 callback=function1
sig 否 签名校验 sig=xxx

响应结果

名称 类型 是否必须 说明
status 必 string 状态码，0代表成功，其他为失败
message 必 string 对status值的描述
request_id 必 string 请求ID，用于问题排查
result 必 object 返回结果
count 必 number 终端数量
data 必 array 终端数组
entity_name 必 string 终端名称
entity_id 必 string 终端唯一标识
entity_desc 必 string 终端描述
create_time 必 number 创建时间戳，单位：秒
last_loctime 必 number 最新一次位置的更新时间
entity_fields 必 object 终端自定义字段
entity_field 必 string/number 终端自定义字段信息，以实际为准

响应示例

{
    "status": 0,
    "message": "OK",
    "request_id": "ef4944b5-9381-4681-b44b-b145bbfafc26-3974ebb4f83a2d6f",
    "result": {
        "count": 2,
        "data": [
            {
                "entity_id": "entity-001",
                "entity_name": "test-002",
                "entity_desc": "测试",
                "create_time": 1652079505,
                "last_loctime": 0,
                "entity_fields": {}
            },
            {
                "entity_id": "entity-002",
                "entity_name": "test-002",
                "entity_desc": "测试",
                "create_time": 1652079860,
                "last_loctime": 0,
                "entity_fields": {
                    "city": "北京市"
                }
            }
        ]
    }
}

这篇文章对您解决问题是否有帮助？

已解决
未解决