你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Route - Post Route Directions Batch
用于在单个异步请求中向 获取路由方向 API 发送一批查询。
Post Route Directions Batch
API 是一个 HTTP POST
请求,它使用单个异步请求将查询批处理发送到 获取路由方向 API。 可以调用 Route Directions Batch
API 以异步(异步)或同步(同步)运行。 异步 API 允许调用方对多达 700 个 查询进行批处理,并将 API 同步到 100 个 查询。 若要在同步请求中调用 Post Route Directions Batch
API,请参阅 路由方向批处理同步。
提交异步批处理请求
异步 API 适用于处理大量相对复杂的路由请求
- 它允许在单独的调用中检索结果(可能有多个下载)。
- 异步 API 针对可靠性进行优化,预计不会遇到超时。
- 此 API 的批项数限制为 700。
使用异步请求发出请求时,默认情况下,服务会返回响应标头的“位置”字段中的重定向 URL 的 202 响应代码。 应定期检查此 URL,直到响应数据或错误信息可用。
异步响应的存储时间为 24 小时
请注意,异步批处理请求是长时间运行的操作。 下面是一系列典型的操作:
- 客户端向 Azure Maps 发送路由方向批处理
POST
请求。
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
服务器将使用以下项之一进行响应:
HTTP
202 Accepted
- 已接受 Batch 请求。HTTP
Error
- 处理 Batch 请求时出错。 这可能是400 Bad Request
或任何其他Error
状态代码。如果成功接受批处理请求,则响应中的
Location
标头包含用于下载批处理请求结果的 URL。 此状态 URI 如下所示:
GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- 客户端在 下载 URL 步骤 3 中发出
GET
请求来下载批处理结果。
批处理请求的 POST 正文
若要发送 路由方向 查询,将使用 POST
请求,其中请求正文将包含 json
格式的 batchItems
数组,Content-Type
标头将设置为 application/json
。 下面是一个示例请求正文,其中包含 3 个 路由方向 查询:
{
"batchItems": [
{ "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
{ "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
{ "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
]
}
批处理中 查询
异步 API 允许调用方对多达 700 个 查询进行批处理,并同步 API 最多 100 个 查询,批处理应至少包含 1 个 查询。
下载异步批处理结果
若要下载异步批处理结果,将向批处理下载终结点发出 GET
请求。 可以从成功 POST
批处理请求的 Location
标头获取此 下载 URL,如下所示:
https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
下面是用于下载批处理结果的典型操作序列:
客户端使用 下载 URL发送
GET
请求。服务器将使用以下项之一进行响应:
HTTP
202 Accepted
- 已接受 Batch 请求,但仍正在处理。 请在一段时间后重试。HTTP
200 OK
- 批处理请求已成功处理。 响应正文包含所有批处理结果。
批处理响应模型
返回的数据内容与异步和同步请求类似。 下载异步批处理请求的结果时,如果批处理已完成处理,响应正文将包含批处理响应。 此批处理响应包含一个 summary
组件,该组件指示作为原始批处理请求的一部分的 totalRequests
,以及成功执行的查询 successfulRequests
。 批处理响应还包括一个 batchItems
数组,其中包含批处理请求中每个查询的响应。
batchItems
将包含结果,其顺序与在批处理请求中发送原始查询的顺序完全相同。
batchItems
中的每个项都包含 statusCode
和 response
字段。
batchItems
中的每个 response
都是以下类型之一:
RouteDirections
- 如果查询成功完成。Error
- 如果查询失败。 在这种情况下,响应将包含code
和message
。
下面是一个示例 Batch 响应,其中 1 个 成功,1 个 失败 结果:
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"statusCode": 200,
"response": {
"routes": [
{
"summary": {
"lengthInMeters": 1758,
"travelTimeInSeconds": 387,
"trafficDelayInSeconds": 0,
"departureTime": "2018-07-17T00:49:56+00:00",
"arrivalTime": "2018-07-17T00:56:22+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1758,
"travelTimeInSeconds": 387,
"trafficDelayInSeconds": 0,
"departureTime": "2018-07-17T00:49:56+00:00",
"arrivalTime": "2018-07-17T00:56:22+00:00"
},
"points": [
{
"latitude": 47.62094,
"longitude": -122.34892
},
{
"latitude": 47.62094,
"longitude": -122.3485
},
{
"latitude": 47.62095,
"longitude": -122.3476
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 40,
"sectionType": "TRAVEL_MODE",
"travelMode": "bicycle"
}
]
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
format
|
path | True |
响应的所需格式。 仅支持 |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-id |
string |
指定哪个帐户与 Microsoft Entra ID 安全模型结合使用。 它表示 Azure Maps 帐户的唯一 ID,可以从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性,请参阅以下 文章 以获取指导。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
batchItems |
要处理的查询列表。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
批处理请求已成功处理。 响应正文包含所有批处理结果。 |
|
202 Accepted |
仅支持异步请求。 已接受请求:已接受请求进行处理。 请使用位置标头中的 URL 重试或访问结果。 标头 Location: string |
|
Other Status Codes |
发生意外错误。 |
安全性
AADToken
这些 Microsoft Entra OAuth 2.0 流。 与 Azure 基于角色的访问配对时, 控制它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问。 任何用户、组或服务主体都可以通过内置角色或由一个或多个对 Azure Maps REST API 的权限组成的自定义角色授予访问权限。
若要实现方案,建议查看
笔记
- 此安全定义 要求 使用
x-ms-client-id
标头来指示应用程序请求访问的 Azure Maps 资源。 这可以从 地图管理 API获取。
Authorization URL
特定于 Azure 公有云实例。 主权云具有唯一的授权 URL,Microsoft Entra ID 配置。
* Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面 配置的。
* 使用 azure Maps Web SDK
- 有关Microsoft标识平台的详细信息,请参阅 Microsoft标识平台概述。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
这是在 Azure 门户中或使用 PowerShell、CLI、Azure SDK 或 REST API 创建 Azure Maps 帐户 时预配的共享密钥。
使用此密钥,任何应用程序都可以访问所有 REST API。 换句话说,此密钥可用作颁发密钥的帐户中的主密钥。
对于公开的应用程序,我们建议使用 机密客户端应用程序 方法来访问 Azure Maps REST API,以便安全地存储密钥。
类型:
apiKey
在:
query
SAS Token
这是一个共享访问签名令牌,它通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面在 azure Maps 资源
使用此令牌,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,建议在 映射帐户资源 上配置允许的源的特定列表,以限制呈现滥用并定期续订 SAS 令牌。
类型:
apiKey
在:
header
示例
Successfully submit a route direction batch request
示例请求
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0
{
"batchItems": [
{
"query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
},
{
"query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
},
{
"query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
}
]
}
示例响应
{
"batchItems": [
{
"statusCode": 400,
"response": {
"error": {
"code": "400 BadRequest",
"message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
}
}
},
{
"statusCode": 200,
"response": {
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1754,
"travelTimeInSeconds": 386,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:02:49+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1754,
"travelTimeInSeconds": 386,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:02:49+00:00"
},
"points": [
{
"latitude": 47.62094,
"longitude": -122.34892
},
{
"latitude": 47.62094,
"longitude": -122.3485
},
{
"latitude": 47.62095,
"longitude": -122.3476
},
{
"latitude": 47.60995,
"longitude": -122.34174
},
{
"latitude": 47.61011,
"longitude": -122.342
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 44,
"sectionType": "TRAVEL_MODE",
"travelMode": "bicycle"
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1772,
"travelTimeInSeconds": 1276,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:17:38+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1772,
"travelTimeInSeconds": 1276,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:17:38+00:00"
},
"points": [
{
"latitude": 40.75982,
"longitude": -73.98493
},
{
"latitude": 40.7601,
"longitude": -73.98483
},
{
"latitude": 40.75984,
"longitude": -73.98417
},
{
"latitude": 40.76047,
"longitude": -73.9837
},
{
"latitude": 40.77095,
"longitude": -73.9736
},
{
"latitude": 40.77114,
"longitude": -73.97356
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 47,
"sectionType": "TRAVEL_MODE",
"travelMode": "pedestrian"
}
]
}
]
}
}
],
"summary": {
"successfulRequests": 2,
"totalRequests": 3
}
}
operation-Location: URL to download the results of the long-running batch request.
定义
名称 | 说明 |
---|---|
Batch |
此类型表示 Batch 服务的请求正文。 |
Batch |
Batch 请求对象 |
Delay |
事件造成的延迟幅度。 这些值对应于 获取交通事件详细信息 API的响应字段 ty 的值。 |
Driving |
指示在机动点的左侧与右侧驾驶。 |
Effective |
调用此路由 API 时使用的有效参数或数据。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Guidance |
指令的类型,例如道路窗体的转弯或更改。 |
Guidance |
标识操纵的代码。 |
Json |
响应的所需格式。 仅支持 |
Junction |
进行机动的交汇点的类型。 对于较大的环岛,将生成两个单独的指令,用于进入和离开环岛。 |
Lat |
表示为纬度和经度的位置。 |
Response |
查询的结果。 如果查询成功完成,则 RouteDirections;否则为 ErrorResponse。 |
Response |
报告的路由响应的节类型 |
Response |
计算路线的旅行模式。 如果在本节中无法实现请求的传输模式,该值将设置为 |
Route | |
Route |
从路由方向批处理服务调用返回的项。 |
Route |
此对象是从成功的路由方向批处理服务调用返回的。 |
Route |
包含与指南相关的元素。 仅当请求指导且可用时,才会显示此字段。 |
Route |
描述操纵的一组属性,例如“向右转”、“保持左转”、“乘坐渡轮”、“乘坐高速公路”、“到达”。 |
Route |
对相互相关的指令元素序列进行分组。 序列范围受 firstInstructionIndex 和 lastInstructionIndex 约束。 当请求人工可读的短信以获取指导(instructionType=text 或标记),则 instructionGroup 将返回一条摘要消息(如果可用)。 |
Route |
路线的一部分的说明,由点列表组成。 请求中提供的每个附加航点将导致返回的路线中附加一条腿。 |
Route |
路由节的摘要对象。 |
Route |
优化的方式点对象。 |
Route |
报告当前调用中使用的有效设置。 |
Route |
路由部分包含有关路由部分的其他信息。 每个部分至少包含元素 |
Route |
流量事件的详细信息,使用 TPEG2-TEC 标准中的定义。 可以包含 effectCode 并导致元素。 |
Route |
流量事件的原因。 可以包含 mainCauseCode 和 subCauseCode 元素。 可用于定义图标和说明。 |
Route |
Summary 对象 |
Simple |
事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 有关详细信息,请参阅“tec”。 |
Summary |
批处理请求结果摘要 |
BatchRequest
此类型表示 Batch 服务的请求正文。
名称 | 类型 | 说明 |
---|---|---|
batchItems |
要处理的查询列表。 |
BatchRequestItem
Batch 请求对象
名称 | 类型 | 说明 |
---|---|---|
query |
string |
此参数包含用于执行非结构化地理编码操作的查询字符串。 查询字符串将逐字传递给搜索 API 进行处理。 |
DelayMagnitude
事件造成的延迟幅度。 这些值对应于 获取交通事件详细信息 API的响应字段 ty 的值。
名称 | 类型 | 说明 |
---|---|---|
0 |
string |
未知。 |
1 |
string |
次要。 |
2 |
string |
温和。 |
3 |
string |
主要。 |
4 |
string |
未定义,用于道路关闭和其他无限期延误。 |
DrivingSide
指示在机动点的左侧与右侧驾驶。
名称 | 类型 | 说明 |
---|---|---|
LEFT |
string |
左。 |
RIGHT |
string |
右。 |
EffectiveSetting
调用此路由 API 时使用的有效参数或数据。
名称 | 类型 | 说明 |
---|---|---|
key |
string |
所使用的参数的名称。 |
value |
string |
所使用的参数的值。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
GuidanceInstructionType
指令的类型,例如道路窗体的转弯或更改。
名称 | 类型 | 说明 |
---|---|---|
DIRECTION_INFO |
string |
方向信息。 |
LOCATION_ARRIVAL |
string |
到达位置。 |
LOCATION_DEPARTURE |
string |
出发地点。 |
LOCATION_WAYPOINT |
string |
路点位置。 |
ROAD_CHANGE |
string |
道路更改。 |
TURN |
string |
转。 |
GuidanceManeuver
标识操纵的代码。
名称 | 类型 | 说明 |
---|---|---|
ARRIVE |
string |
你已经到了 |
ARRIVE_LEFT |
string |
你已经到了 目标位于左侧。 |
ARRIVE_RIGHT |
string |
你已经到了 目标位于右侧。 |
BEAR_LEFT |
string |
熊离开了 |
BEAR_RIGHT |
string |
熊右。 |
DEPART |
string |
离开。 |
ENTER_FREEWAY |
string |
走高速公路。 |
ENTER_HIGHWAY |
string |
走高速公路。 |
ENTER_MOTORWAY |
string |
走高速公路。 |
ENTRANCE_RAMP |
string |
走坡道。 |
FOLLOW |
string |
跟随。 |
KEEP_LEFT |
string |
保持左。 |
KEEP_RIGHT |
string |
保持正确。 |
MAKE_UTURN |
string |
使 U 轮。 |
MOTORWAY_EXIT_LEFT |
string |
退出左侧。 |
MOTORWAY_EXIT_RIGHT |
string |
退出右侧。 |
ROUNDABOUT_BACK |
string |
四处走动。 |
ROUNDABOUT_CROSS |
string |
穿过环岛。 |
ROUNDABOUT_LEFT |
string |
在环岛,左路走出口。 |
ROUNDABOUT_RIGHT |
string |
在环形交叉路口,从右侧退出。 |
SHARP_LEFT |
string |
左转锋利。 |
SHARP_RIGHT |
string |
向右翻转。 |
STRAIGHT |
string |
保持直截了当。 |
SWITCH_MAIN_ROAD |
string |
切换到主干道。 |
SWITCH_PARALLEL_ROAD |
string |
切换到并行道路。 |
TAKE_EXIT |
string |
退出。 |
TAKE_FERRY |
string |
乘坐渡轮。 |
TRY_MAKE_UTURN |
string |
尝试进行 U 轮次。 |
TURN_LEFT |
string |
向左转。 |
TURN_RIGHT |
string |
向右转。 |
WAYPOINT_LEFT |
string |
你已经到达了路点。 它位于左侧。 |
WAYPOINT_REACHED |
string |
你已经到达了路点。 |
WAYPOINT_RIGHT |
string |
你已经到达了路点。 它就在右边。 |
JsonFormat
响应的所需格式。 仅支持 json
格式。
名称 | 类型 | 说明 |
---|---|---|
json |
string |
JunctionType
进行机动的交汇点的类型。 对于较大的环岛,将生成两个单独的指令,用于进入和离开环岛。
名称 | 类型 | 说明 |
---|---|---|
BIFURCATION |
string |
分 岔 |
REGULAR |
string |
定期 |
ROUNDABOUT |
string |
环形交叉 |
LatLongPair
表示为纬度和经度的位置。
名称 | 类型 | 说明 |
---|---|---|
latitude |
number |
Latitude 属性 |
longitude |
number |
经度属性 |
Response
查询的结果。 如果查询成功完成,则 RouteDirections;否则为 ErrorResponse。
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
|
formatVersion |
string |
Format Version 属性 |
optimizedWaypoints |
优化了路点序列。 它显示用户提供的针对原始列表和优化列表的路点序列的索引。 例如,响应:
表示原始序列为 [0, 1, 2] 且优化序列为 [1, 2, 0]。 由于索引从 0 开始,原始索引为“first,second, third”,而优化为“second, third, first”。 |
|
report |
报告当前调用中使用的有效设置。 |
|
routes |
Route[] |
路由数组 |
ResponseSectionType
报告的路由响应的节类型
名称 | 类型 | 说明 |
---|---|---|
CARPOOL |
string |
需要使用汽车池(HOV/高占用车辆)车道的路线部分。 |
CAR_TRAIN |
string |
路线的各部分是汽车或火车。 |
COUNTRY |
string |
指示路线所在的国家/地区的部分。 |
FERRY |
string |
渡轮路线的各部分。 |
MOTORWAY |
string |
高速公路的路段。 |
PEDESTRIAN |
string |
路线部分仅适用于行人。 |
TOLL_ROAD |
string |
需要支付通行费的路线部分。 |
TOLL_VIGNETTE |
string |
需要提供收费 vignette 的路线部分。 |
TRAFFIC |
string |
包含流量信息的路由部分。 |
TRAVEL_MODE |
string |
与请求参数 |
TUNNEL |
string |
隧道的路由部分。 |
URBAN |
string |
位于城市地区的路线部分。 |
ResponseTravelMode
计算路线的旅行模式。 如果在本节中无法实现请求的传输模式,该值将设置为 other
名称 | 类型 | 说明 |
---|---|---|
bicycle |
string |
返回的路线针对自行车进行了优化,包括自行车道的使用。 |
bus |
string |
返回的路线针对公共汽车进行了优化,包括仅使用公交车道。 BETA 功能。 |
car |
string |
返回的路线针对汽车进行了优化。 |
motorcycle |
string |
返回的路线针对摩托车进行了优化。 BETA 功能。 |
other |
string |
本节中无法提供给定的传输模式 |
pedestrian |
string |
返回的路线针对行人进行了优化,包括人行道的使用。 |
taxi |
string |
返回的路线针对出租车进行了优化。 BETA 功能。 |
truck |
string |
返回的路线针对商用车辆进行了优化,例如卡车。 |
van |
string |
返回的路线针对面包车进行了优化。 BETA 功能。 |
Route
名称 | 类型 | 说明 |
---|---|---|
guidance |
包含与指南相关的元素。 仅当请求指导且可用时,才会显示此字段。 |
|
legs |
Route |
腿数组 |
sections |
节数组 |
|
summary |
Summary 对象 |
RouteDirectionsBatchItem
从路由方向批处理服务调用返回的项。
名称 | 类型 | 说明 |
---|---|---|
response |
查询的结果。 如果查询成功完成,则 RouteDirections;否则为 ErrorResponse。 |
|
statusCode |
integer |
HTTP 请求状态代码。 |
RouteDirectionsBatchResult
此对象是从成功的路由方向批处理服务调用返回的。
名称 | 类型 | 说明 |
---|---|---|
batchItems |
包含批处理结果的数组。 |
|
summary |
批处理请求结果摘要 |
RouteGuidance
包含与指南相关的元素。 仅当请求指导且可用时,才会显示此字段。
名称 | 类型 | 说明 |
---|---|---|
instructionGroups |
对相互相关的指令元素序列进行分组。 |
|
instructions |
描述操作的说明列表。 |
RouteInstruction
描述操纵的一组属性,例如“向右转”、“保持左转”、“乘坐渡轮”、“乘坐高速公路”、“到达”。
名称 | 类型 | 说明 |
---|---|---|
combinedMessage |
string |
操作的人类可读消息与下一个指令中的消息相结合。 有时,可以将两个连续指令组合成一个指令,以便更轻松地遵循。 在这种情况下,possibleCombineWithNext 标志为 true。 例如:
指令 10 上的 possibleCombineWithNext 标志为 true。 这向编码指南的客户端表示,它可以与指令 11 结合使用。 对于请求人工可读指南的客户端,这些说明将自动组合在一起。 combinedMessage 字段包含合并的消息:
|
countryCode |
string |
3 个字符 ISO 3166-1 alpha-3 国家/地区代码。 例如美国 |
drivingSide |
指示在机动点的左侧与右侧驾驶。 |
|
exitNumber |
string |
当前机动采取的高速公路出口数量。 如果退出具有多个退出编号,则它们将用 “,”分隔,并且可能由“-”聚合,例如“10,13-15”。 |
instructionType |
指令的类型,例如道路窗体的转弯或更改。 |
|
junctionType |
进行机动的交汇点的类型。 对于较大的环岛,将生成两个单独的指令,用于进入和离开环岛。 |
|
maneuver |
标识操纵的代码。 |
|
message |
string |
一条人类可读的信息,用于操纵。 |
point |
表示为纬度和经度的位置。 |
|
pointIndex |
integer |
与指令点相对应的折线“磅”列表中的点的索引。 |
possibleCombineWithNext |
boolean |
可以选择将指令与下一个指令组合在一起。 这可用于生成消息,例如“向左转,然后向右转”。 |
roadNumbers |
string[] |
机动后下一条重要路段(s)或要跟踪的道路段的路号(s)。 示例:[“E34”、“N205”] |
roundaboutExitNumber |
integer |
这表示在环流处要采取的退出。 |
routeOffsetInMeters |
integer |
从路线起点到指令点的距离。 |
signpostText |
string |
标志标上的文本与操纵最相关,或与应遵循的方向有关。 |
stateCode |
string |
国家/地区的细分(例如,状态)由 ISO 3166-2 代码的第二部分表示。 这仅适用于美国、加拿大和墨西哥等一些国家/地区。 |
street |
string |
机动后下一条重要路段的街道名称,或应遵循的街道的名称。 |
travelTimeInSeconds |
integer |
估计到与 routeOffsetInMeters 对应的点的行程时间。 |
turnAngleInDecimalDegrees |
integer |
指示指令的方向。 如果 junctionType 指示轮次指令:
如果 junctionType 指示分叉指令:
|
RouteInstructionGroup
对相互相关的指令元素序列进行分组。 序列范围受 firstInstructionIndex 和 lastInstructionIndex 约束。 当请求人工可读的短信以获取指导(instructionType=text 或标记),则 instructionGroup 将返回一条摘要消息(如果可用)。
名称 | 类型 | 说明 |
---|---|---|
firstInstructionIndex |
integer |
指令中的第一个指令的索引,属于此组。 |
groupLengthInMeters |
integer |
组的长度。 |
groupMessage |
string |
当请求人工可读短信以获取指导时摘要消息(instructionType=text 或标记)。 |
lastInstructionIndex |
integer |
说明中最后一个指令的索引,属于此组。 |
RouteLeg
路线的一部分的说明,由点列表组成。 请求中提供的每个附加航点将导致返回的路线中附加一条腿。
名称 | 类型 | 说明 |
---|---|---|
points |
点数组 |
|
summary |
路由节的摘要对象。 |
RouteLegSummary
路由节的摘要对象。
名称 | 类型 | 说明 |
---|---|---|
arrivalTime |
string |
路线或腿部的估计到达时间。 时间采用 UTC 格式。 |
batteryConsumptionInkWh |
number |
使用电耗模型估计的电耗以千瓦时(千瓦时为单位)。 如果 vehicleEngineType 设置为电动,并且指定 constantSpeedConsumptionInkWhPerHundredkm,则包含该类型。 batteryConsumptionInkWh 的值包括回收的电力,因此可以是负数(这表示获得能量)。 如果同时指定 maxChargeInkWh 和 currentChargeInkWh,则回收将被封顶,以确保电池电量永远不会超过 maxChargeInkWh。 如果未指定 maxChargeInkWh 和 currentChargeInkWh,则会在消耗计算中假定不受约束的回收。 |
departureTime |
string |
路线或腿部的估计出发时间。 时间采用 UTC 格式。 |
fuelConsumptionInLiters |
number |
使用燃烧消耗模型估计升的燃油消耗量。 如果 vehicleEngineType 设置为 燃烧 且指定 constantSpeedConsumptionInLitersPerHundredkm,则包含该类型。 该值将为非负值。 |
historicTrafficTravelTimeInSeconds |
integer |
使用依赖于时间的历史交通数据计算的估计行程时间。 仅当 computeTravelTimeFor = 所有在查询中使用时才包含。 |
lengthInMeters |
integer |
Length In Meters 属性 |
liveTrafficIncidentsTravelTimeInSeconds |
integer |
使用实时速度数据计算的估计行程时间。 仅当 computeTravelTimeFor = 所有在查询中使用时才包含。 |
noTrafficTravelTimeInSeconds |
integer |
估计的行程时间计算为由于交通状况(例如拥堵)而没有延误路线。 仅当 computeTravelTimeFor = 所有在查询中使用时才包含。 |
trafficDelayInSeconds |
integer |
根据交通信息,由实时事件造成的估计延迟(秒)。 对于计划在将来出发时间的航线,延误始终为 0。 若要使用不同类型的交通信息返回其他旅行时间,需要添加参数 computeTravelTimeFor=all。 |
travelTimeInSeconds |
integer |
估计的行程时间(以秒为单位)属性,其中包括由于实时流量导致的延迟。 请注意,即使 traffic=false travelTimeInSeconds 仍包含由于流量导致的延迟。 如果 TravelAt 在将来,则使用依赖于时间的历史交通数据计算行程时间。 |
RouteOptimizedWaypoint
优化的方式点对象。
名称 | 类型 | 说明 |
---|---|---|
optimizedIndex |
integer |
从系统优化的方式点索引。 |
providedIndex |
integer |
用户提供的路点索引。 |
RouteReport
报告当前调用中使用的有效设置。
名称 | 类型 | 说明 |
---|---|---|
effectiveSettings |
调用此路由 API 时使用的有效参数或数据。 |
RouteSection
路由部分包含有关路由部分的其他信息。 每个部分至少包含元素 startPointIndex
、endPointIndex
和 sectionType
。
名称 | 类型 | 说明 |
---|---|---|
delayInSeconds |
integer |
事件导致的延迟(以秒为单位)。 |
effectiveSpeedInKmh |
integer |
事件的有效速度(以公里/小时为单位)平均超过其整个长度。 |
endPointIndex |
integer |
此部分适用的路由中最后一个点(偏移量 0)的索引。 |
magnitudeOfDelay |
事件造成的延迟幅度。 这些值对应于 获取交通事件详细信息 API的响应字段 ty 的值。 |
|
sectionType |
报告的路由响应的节类型 |
|
simpleCategory |
事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 有关详细信息,请参阅“tec”。 |
|
startPointIndex |
integer |
此部分适用的路由中第一个点(偏移量 0)的索引。 |
tec |
流量事件的详细信息,使用 TPEG2-TEC 标准中的定义。 可以包含 effectCode 并导致元素。 |
|
travelMode |
计算路线的旅行模式。 如果在本节中无法实现请求的传输模式,该值将设置为 |
RouteSectionTec
流量事件的详细信息,使用 TPEG2-TEC 标准中的定义。 可以包含 effectCode 并导致元素。
名称 | 类型 | 说明 |
---|---|---|
causes |
导致数组 |
|
effectCode |
integer |
对流量流的影响。 包含 tec001:EffectCode 表中的值,如 TPEG2-TEC 标准中定义。 可用于根据严重性对流量事件进行颜色编码。 |
RouteSectionTecCause
流量事件的原因。 可以包含 mainCauseCode 和 subCauseCode 元素。 可用于定义图标和说明。
名称 | 类型 | 说明 |
---|---|---|
mainCauseCode |
integer |
流量事件的主要原因。 包含 tec002:CauseCode 表中的值,如 TPEG2-TEC 标准中定义。 |
subCauseCode |
integer |
流量事件的子项。 包含由 mainCauseCode 定义的子原因表中的值,如 TPEG2-TEC 标准中定义。 |
RouteSummary
Summary 对象
名称 | 类型 | 说明 |
---|---|---|
arrivalTime |
string |
路线或腿部的估计到达时间。 时间采用 UTC 格式。 |
departureTime |
string |
路线或腿部的估计出发时间。 时间采用 UTC 格式。 |
lengthInMeters |
integer |
Length In Meters 属性 |
trafficDelayInSeconds |
integer |
根据交通信息,由实时事件造成的估计延迟(秒)。 对于计划在将来出发时间的航线,延误始终为 0。 若要使用不同类型的交通信息返回其他旅行时间,需要添加参数 computeTravelTimeFor=all。 |
travelTimeInSeconds |
integer |
估计的行程时间(以秒为单位)属性,其中包括由于实时流量导致的延迟。 请注意,即使 traffic=false travelTimeInSeconds 仍包含由于流量导致的延迟。 如果 TravelAt 在将来,则使用依赖于时间的历史交通数据计算行程时间。 |
SimpleCategory
事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 有关详细信息,请参阅“tec”。
名称 | 类型 | 说明 |
---|---|---|
JAM |
string |
塞车。 |
OTHER |
string |
其他。 |
ROAD_CLOSURE |
string |
道路封闭。 |
ROAD_WORK |
string |
道路工作。 |
Summary
批处理请求结果摘要
名称 | 类型 | 说明 |
---|---|---|
successfulRequests |
integer |
批处理中成功的请求数 |
totalRequests |
integer |
批处理中的请求总数 |