你当前正在访问 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 或 xml。 |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
query
|
query | True |
string |
计算路线所依据的坐标,由冒号分隔。 至少需要两个坐标。 第一个是源,最后一个是路由的目的地。 中间的可选坐标充当路由中的 WayPoint。 最多可传递 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 |
指定用于维持辅助系统的耗电量(以千瓦 (千瓦) 为单位)。 它可用于指定由于交流系统、无线电、加热等设备和系统而导致的消耗量。 合理值: 1.7 |
|
auxiliary
|
query |
number double |
指定用于维持车辆辅助系统的燃料消耗量(以升/小时为单位)。 它可用于指定由于交流系统、无线电、加热等设备和系统而导致的消耗量。 合理值 : 0.2 |
|
avoid
|
query |
指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定,例如,“&avoid=高速公路&avoid=tollRoads&avoid=ferries”。 在路由范围请求中,不得使用已UsedRoads 值。 |
||
compute
|
query |
boolean |
使用快速启发式算法对路线点重新排序,以减少路线长度。 与 routeType 最短结合使用时产生最佳结果。 请注意,源和目标从优化航点索引中排除。 若要在响应中包含源和目标,请将所有索引增加 1 以考虑源,然后将目标添加为最终索引。 可能值为 true 或 false。 如果可能,True 将计算更好的顺序,但不允许与大于 0 的 maxAlternatives 值或与圆路点结合使用。 False 将按给定顺序使用位置,不允许与 routeRepresentation none 结合使用。 |
|
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/100km) 表示 (消耗值的有效范围介于 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 是通过使用 fuelEnergyDensityInMJoulesPerLiter 将节省的 (不消耗) 燃料转换为能源获得的。 必须与 加速效率配对。 允许的值范围是 0.0 到 1/加速效率。 合理值:对于 燃烧模型 :0.83,对于 电气模型 :0.91 |
|
depart
|
query |
string date-time |
从起始点出发的日期和时间,格式为
示例:
参数 |
|
downhill
|
query |
number double |
指定当车辆失去高程 (( 例如 ChemicalEnergySaved/PotentialEnergyLost) )时,将潜在能量转换为节省 (不消耗) 燃料的效率。ChemicalEnergySaved 是通过使用 fuelEnergyDensityInMJoulesPerLiter 将节省的 (不消耗) 燃料转换为能源获得的。 必须与 uphillEfficiency 配对。 允许的值范围是 0.0 到 1/上坡效率。 合理值:对于 燃烧模型 :0.51,对于 电气模型 :0.73 |
|
fuel
|
query |
number double |
指定存储在一升燃料中的化学能量(以兆焦耳 (MJ) 为单位)。 它与 *效率 参数结合使用,用于在节省或消耗的能量与燃料之间进行转换。 例如,汽油的能量密度为 34.2 MJ/l,柴油燃料的能量密度为 35.8 MJ/l。 如果设置了任何 *效率 参数,则此参数是必需的。 合理值 : 34.2 |
|
hilliness
|
query |
惊心动魄路线的丘陵程度。 此参数只能与 =thrilling 一起使用 |
||
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 |
指定作为响应提供的路由集的表示形式。 此参数值只能与 computeBestOrder=true 结合使用。 |
||
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/下坡效率。 合理值:对于 燃烧模型 :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 开头的值用于美国路由,而 otherHazmat 应用于所有其他国家/地区。 可以多次指定 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
这些是 OAuth 2.0 流Microsoft Entra。 与 Azure 基于角色的访问控制配对后,它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。 可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体访问权限,以Azure Maps REST API。
若要实现方案,建议查看 身份验证概念。 总之,此安全定义提供了一个解决方案,用于通过能够对特定 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 标识平台概述。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
这是在Azure 门户或使用 PowerShell、CLI、Azure SDK 或 REST API Create Azure Maps帐户时预配的共享密钥。
使用此密钥,任何应用程序都可以访问所有 REST API。 换句话说,此密钥可以用作颁发它们的帐户中的主密钥。
对于公开的应用程序,我们建议使用机密客户端应用程序方法来访问Azure Maps REST API,以便安全地存储密钥。
Type:
apiKey
In:
query
SAS Token
这是一个共享访问签名令牌,通过 Azure 管理平面通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 在Azure Maps资源上列出 SAS 操作创建。
使用此令牌,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域 () 。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,我们建议在 映射帐户资源 上配置允许的来源的特定列表,以限制呈现滥用,并定期续订 SAS 令牌。
Type:
apiKey
In:
header
示例
Successfully retrieve a route between an origin and a destination
Sample Request
GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings
Sample Response
{
"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 或 xml。 |
Response |
报告的路由响应的节类型 |
Response |
计算路线的出行模式。 如果本部分中无法实现请求的传输模式,则该值将设置为 |
Route | |
Route |
指定在确定路由时路由计算应尝试避免的内容。 可以在一个请求中多次指定,例如,“&avoid=高速公路&avoid=tollRoads&avoid=ferries”。 在路由范围请求中,不得使用 alreadyUsedRoads 值。 |
Route |
此对象是从成功的“路线方向”调用返回的 |
Route |
包含指南相关元素。 仅当请求了指导并可用时,此字段才存在。 |
Route |
描述操作的一组属性,例如“向右转”、“保持左转”、“乘坐渡轮”、“乘坐高速公路”、“到达”。 |
Route |
组彼此相关的指令元素序列。 序列范围受 firstInstructionIndex 和 lastInstructionIndex 的约束。 当请求人类可读文本消息以获取指导 (instructionType=text 或标记) 时,instructionGroup 将返回摘要消息(如果可用)。 |
Route |
如果指定,将返回指导说明。 请注意,instructionsType 参数不能与 routeRepresentation=none 结合使用 |
Route |
路线的一部分的说明,由点列表组成。 请求中提供的每个附加航点将导致返回的路线中增加一条航段。 |
Route |
路由节的摘要对象。 |
Route |
优化的方式点对象。 |
Route |
报告当前调用中使用的有效设置。 |
Route |
指定作为响应提供的路由集的表示形式。 此参数值只能与 computeBestOrder=true 结合使用。 |
Route |
路由部分包含有关路由部分的其他信息。 每个部分至少包含元素 |
Route |
流量事件的详细信息,使用 TPEG2-TEC 标准中的定义。 可以包含 effectCode 并导致 元素。 |
Route |
流量事件的原因。 可以包含 mainCauseCode 和 subCauseCode 元素。 可用于定义图标和说明。 |
Route |
Summary 对象 |
Route |
请求的路由类型。 |
Section |
指定在路由响应中报告哪些节类型。 |
Simple |
事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或 OTHER。 有关详细信息,请参阅“tec”。 |
Travel |
所请求路线的出行模式。 如果未定义,则默认值为“car”。 请注意,请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节,则该节响应的 travelMode 元素将为“other”。 请注意,公交、摩托车、出租车和面包车的出行模式是 BETA 版功能。 并非所有区域都提供完全限制数据。 |
Vehicle |
车辆的发动机类型。 指定详细消耗模型时,它必须与 vehicleEngineType 的值一致。 |
Vehicle |
可归类为危险品并限制在一些道路的货物类型。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9,外加在其他国家/地区使用的泛型分类。 以 USHazmat 开头的值用于美国路由,而 otherHazmat 应用于所有其他国家/地区。 可以多次指定 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 |
切换到main道路。 |
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 |
high |
low |
string |
low |
normal |
string |
一般 |
JunctionType
进行操纵的交汇点的类型。 对于较大的环形交叉路口,将生成两个单独的指令,用于进入和离开环形交叉路口。
名称 | 类型 | 说明 |
---|---|---|
BIFURCATION |
string |
分 岔 |
REGULAR |
string |
普通 |
ROUNDABOUT |
string |
回旋 处 |
LatLongPair
表示为纬度和经度的位置。
名称 | 类型 | 说明 |
---|---|---|
latitude |
number |
Latitude 属性 |
longitude |
number |
Longitude 属性 |
Report
指定应报告哪些数据用于诊断目的。 唯一可能的值是 effectiveSettings。 报告调用 API 时使用的有效参数或数据。 对于默认参数,将在调用方未指定参数的位置反映默认值。
名称 | 类型 | 说明 |
---|---|---|
effectiveSettings |
string |
报告调用 API 时使用的有效参数或数据。 |
ResponseFormat
响应的所需格式。 值可以是 json 或 xml。
名称 | 类型 | 说明 |
---|---|---|
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 |
需要收费站的路线部分。 |
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 |
Sections 数组 |
|
summary |
Summary 对象 |
RouteAvoidType
指定在确定路由时路由计算应尝试避免的内容。 可以在一个请求中多次指定,例如,“&avoid=高速公路&avoid=tollRoads&avoid=ferries”。 在路由范围请求中,不得使用 alreadyUsedRoads 值。
名称 | 类型 | 说明 |
---|---|---|
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 开头,因此原始索引为“第一、第二、第三”,而优化的为“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) ,或 () 后的道路号。 示例:[“E34”, “N205”] |
roundaboutExitNumber |
string |
这指示在环形交叉路口要走哪个出口。 |
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 |
Points 数组 |
|
summary |
路由节的摘要对象。 |
RouteLegSummary
路由节的摘要对象。
名称 | 类型 | 说明 |
---|---|---|
arrivalTime |
string |
路线或航段的预计到达时间。 时间采用 UTC。 |
batteryConsumptionInkWh |
number |
使用用电量模型) 估计的电耗(以千瓦时 (千瓦时为单位)。 如果 vehicleEngineType 设置为 electric 且指定 constantSpeedConsumptionInkWhPerHundredkm,则包含该属性。 batteryConsumptionInkWh 的值包括回收的电量,因此可以是负 (这表示) 获得能量。 如果同时指定了 maxChargeInkWh 和 currentChargeInkWh,则将限制回收,以确保电池充电水平永远不会超过 maxChargeInkWh。 如果 maxChargeInkWh 和 currentChargeInkWh 均未指定,则消耗计算中假定无约束的回收。 |
departureTime |
string |
路线或航段的预计出发时间。 时间采用 UTC。 |
fuelConsumptionInLiters |
number |
使用燃烧消耗模型估计的油耗(以升为单位)。 如果 vehicleEngineType 设置为 燃烧 ,并且指定了 constantSpeedConsumptionInLitersPerHundredkm,则包含。 该值将为非负值。 |
historicTrafficTravelTimeInSeconds |
integer |
使用与时间相关的历史交通数据计算的估计行程时间。 仅在查询中使用 computeTravelTimeFor = all 时才包含。 |
lengthInMeters |
integer |
Length In Meters 属性 |
liveTrafficIncidentsTravelTimeInSeconds |
integer |
使用实时速度数据计算的估计行程时间。 仅在查询中使用 computeTravelTimeFor = all 时包含。 |
noTrafficTravelTimeInSeconds |
integer |
由于交通状况 (例如拥堵) ,估计行程时间的计算方式与路线没有延误一样。 仅在查询中使用 computeTravelTimeFor = all 时才包含。 |
trafficDelayInSeconds |
integer |
实时事件造成的估计延迟 (根据交通信息) 。 对于计划在未来出发时间的路线,延误始终为 0。 若要使用不同类型的交通信息返回其他行程时间,需要添加参数 computeTravelTimeFor=all。 |
travelTimeInSeconds |
integer |
估计行程时间(以秒为单位)属性,包括由于实时流量导致的延迟。 请注意,即使 traffic=false travelTimeInSeconds 仍包含由于流量导致的延迟。 如果将来是 DepartAt,则使用与时间相关的历史交通数据计算旅行时间。 |
RouteOptimizedWaypoint
优化的方式点对象。
名称 | 类型 | 说明 |
---|---|---|
optimizedIndex |
integer |
优化了系统中的路点索引。 |
providedIndex |
integer |
用户提供的路点索引。 |
RouteReport
报告当前调用中使用的有效设置。
名称 | 类型 | 说明 |
---|---|---|
effectiveSettings |
调用此路由 API 时使用的有效参数或数据。 |
RouteRepresentationForBestOrder
指定作为响应提供的路由集的表示形式。 此参数值只能与 computeBestOrder=true 结合使用。
名称 | 类型 | 说明 |
---|---|---|
none |
string |
仅包括优化路点索引,但不包括响应中的路由几何图形。 |
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 或 OTHER。 有关详细信息,请参阅“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 |
流量事件的main原因。 包含 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 仍包含由于流量导致的延迟。 如果将来是 DepartAt,则使用与时间相关的历史交通数据计算旅行时间。 |
RouteType
请求的路由类型。
名称 | 类型 | 说明 |
---|---|---|
eco |
string |
一条由经济和速度平衡的路线。 |
fastest |
string |
最快的路线。 |
shortest |
string |
按距离排序的最短路线。 |
thrilling |
string |
包括有趣或具有挑战性的道路,并使用尽可能少的高速公路。 可以选择包括的转弯级别和丘陵程度。 请参阅丘陵和绕组参数,了解如何设置此值。 计划路线限制为 900 公里,= |
SectionType
指定在路由响应中报告哪些节类型。
例如,如果 sectionType = 行人,则返回仅适用于行人的部分。 可以使用多个类型。 default sectionType 引用 travelMode 输入。 默认情况下,travelMode 设置为 car
名称 | 类型 | 说明 |
---|---|---|
carTrain |
string |
路线的部分是汽车或火车。 |
carpool |
string |
需要使用拼车 (HOV/高占用车辆) 车道的路段。 |
country |
string |
指示路线所在的国家/地区的部分。 |
ferry |
string |
渡轮路线的各部分。 |
motorway |
string |
属于高速公路的路线部分。 |
pedestrian |
string |
路线中仅适用于行人的路段。 |
tollRoad |
string |
需要支付通行费的路线部分。 |
tollVignette |
string |
需要收费站的路线部分。 |
traffic |
string |
包含交通信息的路线部分。 |
travelMode |
string |
与请求参数 |
tunnel |
string |
属于隧道的路线部分。 |
urban |
string |
位于市区内的路线部分。 |
SimpleCategory
事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或 OTHER。 有关详细信息,请参阅“tec”。
名称 | 类型 | 说明 |
---|---|---|
JAM |
string |
交通堵塞。 |
OTHER |
string |
其他。 |
ROAD_CLOSURE |
string |
道路封闭。 |
ROAD_WORK |
string |
道路工程。 |
TravelMode
所请求路线的出行模式。 如果未定义,则默认值为“car”。 请注意,请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节,则该节响应的 travelMode 元素将为“other”。 请注意,公交、摩托车、出租车和面包车的出行模式是 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 开头的值用于美国路由,而 otherHazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数目前仅考虑用于 travelMode=truck。
名称 | 类型 | 说明 |
---|---|---|
USHazmatClass1 |
string |
爆炸品 |
USHazmatClass2 |
string |
压缩气体 |
USHazmatClass3 |
string |
易燃液体 |
USHazmatClass4 |
string |
易燃固体 |
USHazmatClass5 |
string |
氧化剂 |
USHazmatClass6 |
string |
毒药 |
USHazmatClass7 |
string |
放射性物质 |
USHazmatClass8 |
string |
腐蚀剂 |
USHazmatClass9 |
string |
杂项 |
otherHazmatExplosive |
string |
爆炸品 |
otherHazmatGeneral |
string |
杂项 |
otherHazmatHarmfulToWater |
string |
对水有害 |
WindingnessLevel
惊心动魄路线的转弯水平。 此参数只能与 routeType
=thrilling 结合使用。
名称 | 类型 | 说明 |
---|---|---|
high |
string |
high |
low |
string |
low |
normal |
string |
一般 |