服务文档
接口功能介绍
路网创建接口
https://api.map.baidu.com/ros/v1/matrix?ak={您的AK} //POST请求
请求参数
参数名称 | 参数类型 | 是否必须 | 参数说明 | |
---|---|---|---|---|
name | String | 否 | 路网矩阵名称 | |
locationType | String | 否 | 默认值:bd09ll,wgs84:GPS 坐标,gcj02:国测局加密坐标,bd09ll:百度经纬度坐标,bd09mc:百度墨卡托坐标 | |
locations | List | 是 | 网点信息列表,包括仓库 | |
latitude | Double | 是 | 坐标的纬度 | |
longitude | Double | 是 | 坐标的经度 | |
key | String | 是 | 客户网点的唯一key,排单排线需要用到, 长度最大32, 路网中不允许出现key相同的情况 | |
lbsType | List | 是 | LEAST_TIME:时间优先,LEAST_DISTANCE: 距离最短, NO_HIGHWAY: 不走高速,客户可以根据自己场景填写 | |
vehicleType | List | 是 | 路网初始化需要的车型信息, GB01 4.5米箱货, SMALL 小轿车 |
返回参数
参数名称 | 参数类型 | 参数说明 |
---|---|---|
id | String | 路网ID |
commitId | String | 路网版本(增加网点删除网点更新网点 路网版本会变化,路网ID不变) |
status | String | RUNNING, FINISHED, ERROR 计算状态 |
errorCode | String | 错误码 |
errorMessage | String | 错误信息 |
请求示例
POST https://api.map.baidu.com/ros/v1/matrix?ak={您的AK} HTTP/1.1
{
"name": "test",
"locationType": "bd09ll",
"lbsType": [
"LEAST_TIME"
],
"vehicleType": [
"GB01"
],
"locations": [
{
"latitude": 31.863202,
"longitude": 117.103855,
"key": "aaaa"
},
{
"latitude": 31.863202,
"longitude": 117.103855,
"key": "bbbb"
},
{
"latitude": 31.863202,
"longitude": 117.103855,
"key": "vvvv"
}
]
}
返回示例
HTTP/1.1 200 OK
x-bce-request-id: f3d25695-6975-4b2b-a540-18f77907f486
{
"id" : "8b664a457cdd42ec871e8344368c5d79",
"commitId": "ad51151d0252463c83030723bb2f28a0",
"status": "RUNNING",
"errorCode": "",
"errorMessage": ""
}
路网查询接口
https://api.map.baidu.com/ros/v2/matrix?ak={您的AK}&matrixId={matrixId}&commitId={commitId} //GET请求
返回结果
参数名称 | 参数类型 | 参数说明 |
---|---|---|
id | String | 路网ID |
commitId | String | 路网版本(增加网点删除网点更新网点 路网版本会变化,路网ID不变) |
status | String | RUNNING, FINISHED, ERROR 计算状态 |
errorCode | String | 错误码 |
errorMessage | String | 错误信息 |
路网新增/减少网点/更新网点坐标
https://api.map.baidu.com/ros/v2/matrix?ak={您的AK}&matrixId={matrixId} //PUT请求
请求参数
参数名称 | 参数类型 | 是否必须 | 参数说明 | |
---|---|---|---|---|
locations | List | 是 | 网点列表 | |
latitude | Double | 是 | 坐标的纬度 | |
longitude | Double | 是 | 坐标的经度 | |
key | String | 是 | 客户网点的唯一key,排单排线需要用到,长度最大32 | |
type | String | 是 | ADD , DELETE,UPDATE |
返回参数
参数名称 | 参数类型 | 参数说明 |
---|---|---|
id | String | 路网ID |
commitId | String | 路网版本(增加网点删除网点更新网点 路网版本会变化,路网ID不变) |
status | String | RUNNING, FINISHED, ERROR 计算状态 |
errorCode | String | 错误码 |
errorMessage | String | 错误信息 |
网点线路更新
https://api.map.baidu.com/ros/v2/matrix/point?ak={您的AK}&matrixId={matrixId}//PUT请求
请求参数
参数名称 | 参数类型 | 是否必须 | 参数说明 | |
---|---|---|---|---|
from | Location | 是 | 网点信息 | |
latitude | Double | 是 | 坐标的纬度 | |
longitude | Double | 是 | 坐标的经度 | |
key | String | 是 | 客户网点的唯一key,排单排线需要用到 | |
to | Location | 是 | 网点信息 | |
latitude | Double | 是 | 坐标的纬度 | |
longitude | Double | 是 | 坐标的经度 | |
key | String | 是 | 客户网点的唯一key,排单排线需要用到 |
返回参数
参数名称 | 参数类型 | 参数说明 |
---|---|---|
id | String | 路网ID |
commitId | String | 路网版本(增加网点删除网点更新网点 路网版本会变化,路网ID不变) |
status | String | RUNNING, FINISHED, ERROR 计算状态 |
errorCode | String | 错误码 |
errorMessage | String | 错误信息 |
路网删除
https://api.map.baidu.com/ros/v2/matrix/delete?ak={您的AK} //PUT请求
请求参数
参数名称 | 参数类型 | 参数说明 |
---|---|---|
matrixIds | List | 网点的集合Id |
路网任务执行时间查询接口
https://api.map.baidu.com/ros/v1/matrix/current/task?ak={您的AK} //GET请求
请求示例
GET https://api.map.baidu.com/ros/v1/matrix/current/task?ak={您的AK} HTTP/1.1
返回参数
参数名称 | 参数类型 | 参数说明 |
---|---|---|
matrixId | String | 路网ID |
commitId | String | 路网版本(增加网点删除网点更新网点 路网版本会变化,路网ID不变) |
status | String | RUNNING, FINISHED, ERROR 计算状态 |
time | String | 时间信息 |
返回示例
HTTP/1.1 200 OK
x-bce-request-id: c3d25695-697f-4b2b-a540-18f77907f486
[
{
"matrixId" : "d",
"commitId" : "v"
"status" : "RUNNING",
"time" : "3分钟";
}
]
路网任务权重修改接口
https://api.map.baidu.com/ros/v1/matrix/weight?ak={您的AK} //PUT请求
请求参数
参数名称 | 参数类型 | 是否必填 | 参数说明 |
---|---|---|---|
matrixId | String | 是 | 路网ID |
weight | Integer | 是 | 该路网的权重 0最低, 10最高 |
请求示例
GET https://api.map.baidu.com/ros/v1/matrix/weight?ak={您的AK} HTTP/1.1
{
"matrixId": "matrixId",
"weight" : 8
}
返回示例
HTTP/1.1 200 OK
x-bce-request-id: c3d25695-697f-4b2b-a540-18f77907f486
错误码
错误码 | 说明 |
---|---|
MatrixNotFound | 找不到路网 |
InvalidRequestParam | 请求参数错误 |
TypeEmpty | 更新网点的类型不能为空 |
LocationEmpty | 网点信息不能为空 |
MatrixCommitIdNotFound | 路网版本未找到 |
NotFoundAvailableMatrix | 找不到可用的路网 |
ProblemIdsMappingError | 单据中的ID在可用的路网中未找到 |
MatrixNotFinishedUpdate | 当前路网还未完成,不能进行网点的变更操作 |
LocationIdsNotFound | 单据中的用户网点未找到 |
LbsTypesNotFound | 驾驶策略维度信息在路网中未找到 |
VehicleTypeTypesNotFound | 车型维度信息在路网中未找到 |
ServerInternalError | 系统错误 |
TypesNotFoundInMatrix | 无法获取维度信息 |
LbsTypeNotFoundInMatrix | 无法获取驾驶策略维度信息 |
VehicleTypeNotFoundInMatrix | 无法获取车型维度信息 |
MatrixPointError | 网点中的信息有空值 |
MatrixLocationKeyError | 网点中的key最长为32 |
服务状态码
返回码 | 定义 | 常见原因 |
---|---|---|
200 | 返回成功 | 服务请求正常召回 |
400 | 请求失败 | 请求参数不合法,请按照返回提示修改参数 |
401 | 未鉴权 | ak不合法或者账号未开通相应权限 |
403 | 禁止 | 未开通白名单,请前往反馈工单联系我们 |
503 | 服务不可用 | 服务异常,请前往反馈工单联系我们 |
500 | 内部服务错误 | 服务异常,请前往反馈工单联系我们 |
修改于 2022-08-05 08:00:40