你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Route - Get Route Directions
用于计算指定源和目标之间的路由,通过任何指定的路点传递。
Get Route Directions
API 是一个 HTTP GET
请求,它返回源和目标之间的路由,如果指定,则通过路点传递。 该路线考虑了当前交通和一周中所需时间的典型道路速度等因素。
返回的信息包括距离、估计行程时间和路线几何图形的表示形式。 还可以使用其他路由信息,例如优化的路点顺序或轮次指令,具体取决于所选的选项。
路由服务提供了一组参数,用于详细说明特定于车辆的消耗模型。 有关详细信息,请参阅 消耗模型。
GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings§ionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}¤tFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}¤tChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
format
|
path | True |
响应的所需格式。 值可以是 json |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
query
|
query | True |
string |
计算路线的坐标,用冒号分隔。 至少需要两个坐标。 第一个是源,最后一个是路线的目标。 可选坐标在路由中充当 WayPoints。 最多可以传递 150 个 WayPoint。 |
acceleration
|
query |
number double |
指定当车辆加速 (即 KineticEnergyGained/ChemicalEnergyConsumed)时,将燃料中存储的化学能量转换为动能的效率。ChemicalEnergyConsumed 是通过使用 fuelEnergyDensityInMJoulesPerLiter将消耗的燃料转换为化学能量获得的。 必须与 减速配对。 允许的值为 0.0 到 1/减速效率。 合理值:燃烧模型:0.33,电动模型:0.66 |
|
alternative
|
query |
控制与参考路线相比计算的替代项的给定规划条件的最佳性。 |
||
arrive
|
query |
string date-time |
到达目标点的日期和时间,格式为 例子:
|
|
auxiliary
|
query |
number double |
指定用于维持辅助系统(千瓦)的电力量。 它可用于指定由于设备和系统(如 AC 系统、无线电、加热等)的消耗。 合理的值:1.7 |
|
auxiliary
|
query |
number double |
指定用于维持车辆辅助系统的燃料量(以升/小时为单位)。 它可用于指定由于设备和系统(如 AC 系统、无线电、加热等)的消耗。 合理的值:0.2 |
|
avoid
|
query |
指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定“&avoid=高速公路,&避免=tollRoads&avoid=ferries”。 在路由范围请求中,不能使用已使用值UsedRoads。 |
||
compute
|
query |
boolean |
使用快速启发式算法重新排序路由路点,以减少路由长度。 与 routeType 结合使用时,生成最佳结果 最短。 请注意,源和目标从优化的路点索引中排除。 若要在响应中包含源和目标,请将所有索引增加 1 以考虑源,然后将目标添加为最终索引。 可能的值为 true 或 false。 如果可能,则 True 将计算出更好的顺序,但不允许与大于 0 或与圆路点的 maxAlternatives 值结合使用。 False 将使用给定顺序中的位置,不允许与 routeRepresentation 结合使用 无。 |
|
compute
|
query |
指定是否使用不同类型的交通信息(无、历史、实时)以及默认的最佳估计行程时间返回其他旅行时间。 |
||
constant
|
query |
string |
指定消耗速度相关组件。 以无序的速度/消耗率对列表的形式提供。 该列表定义消耗曲线上的点。 在列表中找不到速度的消耗率,如下所示:
该列表必须包含 1 到 25 磅(含),并且不能包含相同速度的重复点。 如果它仅包含一个点,则使用该点的消耗率而不进行进一步处理。 为最大速度指定的消耗必须大于或等于倒数第二个最大速度的消耗量。 这可确保推断不会导致负消耗率。 同样,为列表中的两个最小速度指定的消耗值不能导致任何较小的速度的负消耗率。 消耗值的有效范围(以 kWh/100km 表示)介于 0.01 和 100000.0 之间。 合理的值: 50,8.2:130,21.3 用电模型需要此参数。 |
|
constant
|
query |
string |
指定消耗速度相关组件。 以无序分隔的速度列表的形式提供,& 消耗率对。 该列表定义消耗曲线上的点。 在列表中找不到速度的消耗率,如下所示:
该列表必须包含 1 到 25 磅(含),并且不能包含相同速度的重复点。 如果它仅包含一个点,则使用该点的消耗率而不进行进一步处理。 为最大速度指定的消耗必须大于或等于倒数第二个最大速度的消耗量。 这可确保推断不会导致负消耗率。 同样,为列表中的两个最小速度指定的消耗值不能导致任何较小的速度的负消耗率。 消耗值的有效范围(以 l/100 公里表示)介于 0.01 和 100000.0 之间。 合理的值: 50,6.3:130,11.5 注意:燃烧消耗模型,此参数是必需的。 |
|
current
|
query |
number double |
以千瓦时为单位指定当前电力供应(千瓦时)。 此参数与 maxChargeInkWh 参数共存。 允许的值为 0.0 到 maxChargeInkWh。 合理的值:43 |
|
current
|
query |
number double |
指定当前以升为单位的燃料供应。 合理的值: 55 |
|
deceleration
|
query |
number double |
指定当车辆减速 (即 ChemicalEnergySaved/KineticEnergyLost)时,将动能转换为节约(未消耗)燃料的效率。ChemicalEnergySaved 是通过使用 燃料EnergyDensityInMJoulesPerLiter将节约的(未消耗)燃料转换为能量获得的。 必须与 accelerationEfficiency配对。 允许的值为 0.0 到 1/accelerationEfficiency。 合理的值:对于 燃烧模型: 0.83,对于 电动模型: 0.91 |
|
depart
|
query |
string date-time |
RFC 3339 第 5.6 节(可选时区偏移量)中定义的
例子:
|
|
downhill
|
query |
number double |
指定当车辆失去海拔 (即 ChemicalEnergySaved/PotentialEnergyLost)时将潜在能量转换为节约(未消耗)燃料的效率。ChemicalEnergySaved 是通过使用 燃料EnergyDensityInMJoulesPerLiter将节约的(未消耗)燃料转换为能量获得的。 必须与 上坡效率配对。 允许的值为 0.0 到 1/uphillEfficiency。 合理值:燃烧模型:0.51,电动模型:0.73 |
|
fuel
|
query |
number double |
指定以兆焦(MJ)存储在一升燃料中的化学能量量。 它与 *效率 参数结合使用,用于节省或消耗的能量和燃料之间的转换。 例如,汽油的能源密度为 34.2 MJ/l,柴油为 35.8 MJ/l。 如果设置了任何 *效率 参数,则此参数是必需的。 合理的值:34.2 |
|
hilliness
|
query |
惊心动魄的路线的丘陵程度。 此参数只能与 |
||
instructions
|
query |
如果指定,将返回指导说明。 请注意,instructionsType 参数不能与 routeRepresentation=none 结合使用。 |
||
language
|
query |
string |
语言参数确定指导消息的语言。 适当的名词(街道、广场等的名称)以指定语言返回,或者如果该名词不可用,则以接近它的可用语言返回。 允许的值是 IETF 语言标记(子集)。 当前支持的语言列在 支持的语言部分。 默认值:en-GB |
|
max
|
query |
integer |
要计算的所需备用路由数。 默认值:0、最小值:0 和最大值:5 |
|
max
|
query |
number double |
指定可存储在车辆电池中的千瓦时(千瓦时)的最大电力供应量。 此参数与 currentChargeInkWh 参数共存。 最小值必须大于或等于 currentChargeInkWh。 合理的值: 85 |
|
min
|
query |
integer |
返回的所有备用路由将遵循引用路由(请参阅 POST 请求部分),从 calculateRoute 请求的起始点至少为此数目的计量。 只能在重新构造路由时使用。 minDeviationDistance 参数不能与 arriveAt 结合使用 |
|
min
|
query |
integer |
返回的所有备用路由将遵循引用路由(请参阅 POST 请求部分),从 calculateRoute 请求的起始点至少为此秒数。 只能在重新构造路由时使用。 minDeviationTime 参数不能与 arriveAt 结合使用。 默认值为 0。 将 )minDeviationTime_设置为大于零的值会产生以下后果:
|
|
report
|
query |
指定出于诊断目的应报告哪些数据。 唯一可能的值为 effectiveSettings。 报告调用 API 时使用的有效参数或数据。 对于默认参数,默认值将反映在调用方未指定参数的位置。 |
||
route
|
query |
指定作为响应提供的路由集的表示形式。 |
||
route
|
query |
请求的路由类型。 |
||
section
|
query |
指定路由响应中报告哪些节类型。 |
||
traffic
|
query |
boolean |
可能的值:
|
|
travel
|
query |
所请求路线的旅行模式。 如果未定义,则默认值为“car”。 请注意,请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节,则响应的 travelMode 元素将为“其他”。 请注意,旅行模式巴士、摩托车、出租车和面包车是 BETA 功能。 完全限制数据在所有方面都不可用。 |
||
uphill
|
query |
number double |
指定当车辆提升 (即 PotentialEnergyGained/ChemicalEnergyConsumed)时,将存储在燃料中的化学能量转换为潜在能量的效率。ChemicalEnergyConsumed 是通过使用 fuelEnergyDensityInMJoulesPerLiter将消耗的燃料转换为化学能量获得的。 必须与 下坡效率配对。 允许的值为 0.0 到 1/downhillEfficiency。 合理值:燃烧模型:0.27,电动模型:0.74 |
|
vehicle
|
query |
integer |
车辆每轴重量(以公斤为单位)。 值为 0 表示不考虑每个轴的重量限制。 |
|
vehicle
|
query |
boolean |
车辆是否用于商业目的。 商业车辆不得在一些公路上行驶。 |
|
vehicle
|
query |
车辆的引擎类型。 指定详细消耗模型时,它必须与 vehicleEngineType的值一致。 |
||
vehicle
|
query |
integer |
以度为单位的车辆方向方向从真正的北开始,并继续顺时针方向。 北是0度,东是90度,南是180度,西部是270度。 可能的值 0-359 |
|
vehicle
|
query |
number double |
车辆的高度(以米为单位)。 值为 0 表示不考虑高度限制。 |
|
vehicle
|
query |
number double |
车辆长度(以米为单位)。 值为 0 表示不考虑长度限制。 |
|
vehicle
|
query |
可能归类为危险物质的货物类型,并受某些道路限制。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9,以及用于其他国家/地区的通用分类。 以 USHazmat 开头的值用于美国路由,而其他Hazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数当前仅考虑用于 travelMode=truck。 |
||
vehicle
|
query |
integer |
车辆的最大速度(以公里/小时为单位)。 车辆配置文件中的最大速度用于检查是否允许车辆在高速公路上。
|
|
vehicle
|
query |
integer |
车辆重量(以公斤为单位)。
合理值:燃烧模型:1600,电动模型:1900 |
|
vehicle
|
query |
number double |
车辆宽度(以米为单位)。 值为 0 表示不考虑宽度限制。 |
|
windingness
|
query |
惊心动魄的路线的转弯水平。 此参数只能与 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-id |
string |
指定哪个帐户与 Microsoft Entra ID 安全模型结合使用。 它表示 Azure Maps 帐户的唯一 ID,可以从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性,请参阅以下 文章 以获取指导。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
还行 |
|
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 retrieve a route between an origin and a destination
示例请求
GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings
示例响应
{
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1147,
"travelTimeInSeconds": 162,
"trafficDelayInSeconds": 0,
"departureTime": "2017-09-07T16:56:58+00:00",
"arrivalTime": "2017-09-07T16:59:40+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1147,
"travelTimeInSeconds": 162,
"trafficDelayInSeconds": 0,
"departureTime": "2017-09-07T16:56:58+00:00",
"arrivalTime": "2017-09-07T16:59:40+00:00"
},
"points": [
{
"latitude": 52.50931,
"longitude": 13.42937
},
{
"latitude": 52.50904,
"longitude": 13.42912
},
{
"latitude": 52.50894,
"longitude": 13.42904
},
{
"latitude": 52.50867,
"longitude": 13.42879
},
{
"latitude": 52.5084,
"longitude": 13.42857
},
{
"latitude": 52.50791,
"longitude": 13.42824
},
{
"latitude": 52.50757,
"longitude": 13.42772
},
{
"latitude": 52.50735,
"longitude": 13.42823
},
{
"latitude": 52.5073,
"longitude": 13.42836
},
{
"latitude": 52.50573,
"longitude": 13.43194
},
{
"latitude": 52.50512,
"longitude": 13.43336
},
{
"latitude": 52.50464,
"longitude": 13.43451
},
{
"latitude": 52.5045,
"longitude": 13.43481
},
{
"latitude": 52.50443,
"longitude": 13.43498
},
{
"latitude": 52.50343,
"longitude": 13.43737
},
{
"latitude": 52.50274,
"longitude": 13.43872
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 15,
"sectionType": "TRAVEL_MODE",
"travelMode": "car"
}
]
}
]
}
定义
名称 | 说明 |
---|---|
Alternative |
控制与参考路线相比计算的替代项的给定规划条件的最佳性。 |
Compute |
指定是否使用不同类型的交通信息(无、历史、实时)以及默认的最佳估计行程时间返回其他旅行时间。 |
Delay |
事件造成的延迟幅度。 这些值对应于 获取交通事件详细信息 API的响应字段 ty 的值。 |
Driving |
指示在机动点的左侧与右侧驾驶。 |
Effective |
调用此路由 API 时使用的有效参数或数据。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Guidance |
指令的类型,例如道路窗体的转弯或更改。 |
Guidance |
标识操纵的代码。 |
Incline |
惊心动魄的路线的丘陵程度。 此参数只能与 |
Junction |
进行机动的交汇点的类型。 对于较大的环岛,将生成两个单独的指令,用于进入和离开环岛。 |
Lat |
表示为纬度和经度的位置。 |
Report |
指定出于诊断目的应报告哪些数据。 唯一可能的值为 effectiveSettings。 报告调用 API 时使用的有效参数或数据。 对于默认参数,默认值将反映在调用方未指定参数的位置。 |
Response |
响应的所需格式。 值可以是 json |
Response |
报告的路由响应的节类型 |
Response |
计算路线的旅行模式。 如果在本节中无法实现请求的传输模式,该值将设置为 |
Route | |
Route |
指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定“&avoid=高速公路,&避免=tollRoads&avoid=ferries”。 在路由范围请求中,不能使用已使用值UsedRoads。 |
Route |
此对象是从成功的路线方向调用返回的 |
Route |
包含与指南相关的元素。 仅当请求指导且可用时,才会显示此字段。 |
Route |
描述操纵的一组属性,例如“向右转”、“保持左转”、“乘坐渡轮”、“乘坐高速公路”、“到达”。 |
Route |
对相互相关的指令元素序列进行分组。 序列范围受 firstInstructionIndex 和 lastInstructionIndex 约束。 当请求人工可读的短信以获取指导(instructionType=text 或标记),则 instructionGroup 将返回一条摘要消息(如果可用)。 |
Route |
如果指定,将返回指导说明。 请注意,instructionsType 参数不能与 routeRepresentation=none 结合使用。 |
Route |
路线的一部分的说明,由点列表组成。 请求中提供的每个附加航点将导致返回的路线中附加一条腿。 |
Route |
路由节的摘要对象。 |
Route |
优化的方式点对象。 |
Route |
报告当前调用中使用的有效设置。 |
Route |
指定作为响应提供的路由集的表示形式。 |
Route |
路由部分包含有关路由部分的其他信息。 每个部分至少包含元素 |
Route |
流量事件的详细信息,使用 TPEG2-TEC 标准中的定义。 可以包含 effectCode 并导致元素。 |
Route |
流量事件的原因。 可以包含 mainCauseCode 和 subCauseCode 元素。 可用于定义图标和说明。 |
Route |
Summary 对象 |
Route |
请求的路由类型。 |
Section |
指定路由响应中报告哪些节类型。 |
Simple |
事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 有关详细信息,请参阅“tec”。 |
Travel |
所请求路线的旅行模式。 如果未定义,则默认值为“car”。 请注意,请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节,则响应的 travelMode 元素将为“其他”。 请注意,旅行模式巴士、摩托车、出租车和面包车是 BETA 功能。 完全限制数据在所有方面都不可用。 |
Vehicle |
车辆的引擎类型。 指定详细消耗模型时,它必须与 vehicleEngineType的值一致。 |
Vehicle |
可能归类为危险物质的货物类型,并受某些道路限制。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9,以及用于其他国家/地区的通用分类。 以 USHazmat 开头的值用于美国路由,而其他Hazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数当前仅考虑用于 travelMode=truck。 |
Windingness |
惊心动魄的路线的转弯水平。 此参数只能与 |
AlternativeRouteType
控制与参考路线相比计算的替代项的给定规划条件的最佳性。
名称 | 类型 | 说明 |
---|---|---|
anyRoute |
string |
允许返回任何替代路由,而不考虑它与引用路由的比较方式(以最佳性而言)。 |
betterRoute |
string |
仅当它比根据给定规划条件的引用路由更好时,才返回备用路由。 |
ComputeTravelTime
指定是否使用不同类型的交通信息(无、历史、实时)以及默认的最佳估计行程时间返回其他旅行时间。
名称 | 类型 | 说明 |
---|---|---|
all |
string |
计算所有类型的交通信息的行程时间,并指定路由响应中摘要中包含的字段 noTrafficTravelTimeInSeconds、historicTrafficTravelTimeInSeconds 和 liveTrafficIncidentsTravelTimeInSeconds 中的所有结果。 |
none |
string |
不计算额外的行程时间。 |
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 |
你已经到达了路点。 它就在右边。 |
InclineLevel
惊心动魄的路线的丘陵程度。 此参数只能与 routeType
=thrilling 结合使用。
名称 | 类型 | 说明 |
---|---|---|
high |
string |
高 |
low |
string |
低 |
normal |
string |
正常 |
JunctionType
进行机动的交汇点的类型。 对于较大的环岛,将生成两个单独的指令,用于进入和离开环岛。
名称 | 类型 | 说明 |
---|---|---|
BIFURCATION |
string |
分 岔 |
REGULAR |
string |
定期 |
ROUNDABOUT |
string |
环形交叉 |
LatLongPair
表示为纬度和经度的位置。
名称 | 类型 | 说明 |
---|---|---|
latitude |
number |
Latitude 属性 |
longitude |
number |
经度属性 |
Report
指定出于诊断目的应报告哪些数据。 唯一可能的值为 effectiveSettings。 报告调用 API 时使用的有效参数或数据。 对于默认参数,默认值将反映在调用方未指定参数的位置。
名称 | 类型 | 说明 |
---|---|---|
effectiveSettings |
string |
报告调用 API 时使用的有效参数或数据。 |
ResponseFormat
响应的所需格式。 值可以是 json
名称 | 类型 | 说明 |
---|---|---|
json |
string |
|
xml |
string |
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 对象 |
RouteAvoidType
指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定“&avoid=高速公路,&避免=tollRoads&avoid=ferries”。 在路由范围请求中,不能使用已使用值UsedRoads。
名称 | 类型 | 说明 |
---|---|---|
alreadyUsedRoads |
string |
避免多次使用相同的道路。 最有用的与 |
borderCrossings |
string |
避免在路由计算中跨越边界。 |
carpools |
string |
避免需要使用拼车(HOV/高占用车辆)车道的路线。 |
ferries |
string |
避免渡轮 |
motorways |
string |
避免高速公路 |
tollRoads |
string |
避免收费公路。 |
unpavedRoads |
string |
避免未修补的道路 |
RouteDirections
此对象是从成功的路线方向调用返回的
名称 | 类型 | 说明 |
---|---|---|
formatVersion |
string |
Format Version 属性 |
optimizedWaypoints |
优化了路点序列。 它显示用户提供的针对原始列表和优化列表的路点序列的索引。 例如,响应:
表示原始序列为 [0, 1, 2] 且优化序列为 [1, 2, 0]。 由于索引从 0 开始,原始索引为“first,second, third”,而优化为“second, third, first”。 |
|
report |
报告当前调用中使用的有效设置。 |
|
routes |
Route[] |
路由数组 |
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 |
说明中最后一个指令的索引,属于此组。 |
RouteInstructionsType
如果指定,将返回指导说明。 请注意,instructionsType 参数不能与 routeRepresentation=none 结合使用。
名称 | 类型 | 说明 |
---|---|---|
coded |
string |
返回没有人工可读消息的原始指令数据。 |
tagged |
string |
返回带有标记的可读邮件的原始指令数据,以允许格式设置。 由可重复识别的元素构建可读消息。 这些标记允许客户端应用程序正确设置格式。 当 instructionsType=tagged 时,将标记以下消息组件:street、roadNumber、signpostText、exitNumber、roundaboutExitNumber。 标记的“左转”消息示例:
|
text |
string |
以纯文本形式返回具有人类可读消息的原始指令数据。 |
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 时使用的有效参数或数据。 |
RouteRepresentationForBestOrder
指定作为响应提供的路由集的表示形式。
名称 | 类型 | 说明 |
---|---|---|
none |
string |
仅包括优化的 waypoint 索引,但不包括响应中的路由几何图形。 此参数值只能与 computeBestOrder=true 结合使用。 |
polyline |
string |
在响应中包含路由几何图形。 |
summaryOnly |
string |
按折线汇总,但不包括响应中路由的点几何图形元素。 |
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 在将来,则使用依赖于时间的历史交通数据计算行程时间。 |
RouteType
请求的路由类型。
名称 | 类型 | 说明 |
---|---|---|
eco |
string |
经济和速度平衡的路线。 |
fastest |
string |
最快路线。 |
shortest |
string |
最短的路线(按距离)。 |
thrilling |
string |
包括有趣的或具有挑战性的道路,并尽可能少地使用高速公路。 可以选择包括的轮次级别以及丘陵程度。 有关如何设置此参数,请参阅丘陵和曲折参数。 计划路线限制为 900 公里, |
SectionType
指定路由响应中报告哪些节类型。
例如,如果 sectionType = 行人,则仅返回适合行人的部分。 可以在一个请求中多次指定,例如,'§ionType=carTrain§ionType=pedestrian§ionType=motorway'。 默认 sectionType 引用 travelMode 输入。 默认情况下,travelMode 设置为汽车
名称 | 类型 | 说明 |
---|---|---|
carTrain |
string |
路线的各部分是汽车或火车。 |
carpool |
string |
需要使用汽车池(HOV/高占用车辆)车道的路线部分。 |
country |
string |
指示路线所在的国家/地区的部分。 |
ferry |
string |
渡轮路线的各部分。 |
motorway |
string |
高速公路的路段。 |
pedestrian |
string |
路线部分仅适用于行人。 |
tollRoad |
string |
需要支付通行费的路线部分。 |
tollVignette |
string |
需要提供收费 vignette 的路线部分。 |
traffic |
string |
包含流量信息的路由部分。 |
travelMode |
string |
与请求参数 |
tunnel |
string |
隧道的路由部分。 |
urban |
string |
位于城市地区的路线部分。 |
SimpleCategory
事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 有关详细信息,请参阅“tec”。
名称 | 类型 | 说明 |
---|---|---|
JAM |
string |
塞车。 |
OTHER |
string |
其他。 |
ROAD_CLOSURE |
string |
道路封闭。 |
ROAD_WORK |
string |
道路工作。 |
TravelMode
所请求路线的旅行模式。 如果未定义,则默认值为“car”。 请注意,请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节,则响应的 travelMode 元素将为“其他”。 请注意,旅行模式巴士、摩托车、出租车和面包车是 BETA 功能。 完全限制数据在所有方面都不可用。
名称 | 类型 | 说明 |
---|---|---|
bicycle |
string |
返回的路线针对自行车进行了优化,包括自行车道的使用。 |
bus |
string |
返回的路线针对公共汽车进行了优化,包括仅使用公交车道。 BETA 功能。 |
car |
string |
返回的路线针对汽车进行了优化。 |
motorcycle |
string |
返回的路线针对摩托车进行了优化。 BETA 功能。 |
pedestrian |
string |
返回的路线针对行人进行了优化,包括人行道的使用。 |
taxi |
string |
返回的路线针对出租车进行了优化。 BETA 功能。 |
truck |
string |
返回的路线针对商用车辆进行了优化,例如卡车。 |
van |
string |
返回的路线针对面包车进行了优化。 BETA 功能。 |
VehicleEngineType
车辆的引擎类型。 指定详细消耗模型时,它必须与 vehicleEngineType的值一致。
名称 | 类型 | 说明 |
---|---|---|
combustion |
string |
内燃机。 |
electric |
string |
电动发动机。 |
VehicleLoadType
可能归类为危险物质的货物类型,并受某些道路限制。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9,以及用于其他国家/地区的通用分类。 以 USHazmat 开头的值用于美国路由,而其他Hazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数当前仅考虑用于 travelMode=truck。
名称 | 类型 | 说明 |
---|---|---|
USHazmatClass1 |
string |
炸药 |
USHazmatClass2 |
string |
压缩气体 |
USHazmatClass3 |
string |
易燃液体 |
USHazmatClass4 |
string |
易燃固体 |
USHazmatClass5 |
string |
Oxidizers |
USHazmatClass6 |
string |
毒药 |
USHazmatClass7 |
string |
放射性 |
USHazmatClass8 |
string |
腐蚀 |
USHazmatClass9 |
string |
杂项 |
otherHazmatExplosive |
string |
炸药 |
otherHazmatGeneral |
string |
杂项 |
otherHazmatHarmfulToWater |
string |
有害于水 |
WindingnessLevel
惊心动魄的路线的转弯水平。 此参数只能与 routeType
=thrilling 结合使用。
名称 | 类型 | 说明 |
---|---|---|
high |
string |
高 |
low |
string |
低 |
normal |
string |
正常 |