你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Route - Get Route Range

用于创建一个地图,该地图描述根据时间、距离或燃料容量在特定阈值内从给定点访问的区域。

Get Route Range (等时等) API 是一个 HTTP GET 请求,它将根据指定的燃料、能源、时间或距离预算计算一组可从出发点到达的位置。 逆时针方向返回多边形边界 (或等时线) ,以及原点结果的精确多边形中心。

返回的多边形可用于进一步处理,例如 在几何内部搜索 ,以搜索提供的等时等值内的 POI。

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}&fuelBudgetInLiters={fuelBudgetInLiters}&energyBudgetInkWh={energyBudgetInkWh}&timeBudgetInSec={timeBudgetInSec}&distanceBudgetInMeters={distanceBudgetInMeters}&departAt={departAt}&routeType={routeType}&traffic={traffic}&avoid={avoid}&travelMode={travelMode}&hilliness={hilliness}&windingness={windingness}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

URI 参数

名称 必需 类型 说明
format
path True

ResponseFormat

响应的所需格式。 值可以是 jsonxml

api-version
query True

string

Azure Maps API 的版本号。

query
query True

number[]

范围计算应从其开始的坐标。

accelerationEfficiency
query

number

double

指定当车辆加速 ( 即 KineticEnergyGained/ChemicalEnergyConsumed) 时,将存储在燃料中的化学能转换为动能的效率。ChemicalEnergyConsumed 是通过使用 fuelEnergyDensityInMJoulesPerLiter 将消耗的燃料转换为化学能获得的。

必须与 减速效率配对。

允许的值范围为 0.0 到 1/减速效率

合理值:对于 燃烧模型 :0.33,对于 电动模型 :0.66

auxiliaryPowerInkW
query

number

double

指定用于维持辅助系统的功耗,以千瓦 (kW) 为单位。

它可用于指定设备和系统(如交流系统、无线电、加热等)的消耗量。

合理值:1.7

auxiliaryPowerInLitersPerHour
query

number

double

指定用于维持车辆辅助系统的燃料消耗量(以升/小时为单位)。

它可用于指定设备和系统(如交流系统、无线电、加热等)的消耗量。

合理值:0.2

avoid
query

RouteAvoidType[]

指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定,例如,“&avoid=高速公路&avoid=tollRoads&avoid=ferries”。 在路由范围请求中,不得使用已UsedRoads 值。

constantSpeedConsumptionInkWhPerHundredkm
query

string

指定消耗的速度相关分量。

以无序的速度/消耗率对列表的形式提供。 该列表定义消耗曲线上的点。 列表中未列出的速度消耗率如下所示:

  • 如果给定速度位于列表中的两个速度之间,则按线性内插

  • 由线性推断,否则,假设常量 (ΟConsumption/ーSpeed) 由列表中最近的两个点决定

该列表必须包含 1 到 25 个点, (包含) ,并且不能包含相同速度的重复点。 如果它只包含单个点,则使用该点的消耗率而无需进一步处理。

为最大速度指定的消耗量必须大于或等于倒数第二个最大速度的消耗量。 这可确保外推不会导致负消耗率。

同样,为列表中的两个最小速度指定的消耗值不能导致任何较小速度的负消耗率。

(以 kWh/100km) 表示的消耗值的有效范围为 0.01 到 100000.0。

合理值:50,8.2:130,21.3

电量模型需要此参数。

constantSpeedConsumptionInLitersPerHundredkm
query

string

指定消耗的速度相关分量。

以冒号分隔的速度 & 消耗率对的无序列表形式提供。 该列表定义消耗曲线上的点。 列表中未列出的速度消耗率如下所示:

  • 如果给定速度位于列表中的两个速度之间,则按线性内插

  • 由线性推断,否则,假设常量 (ΟConsumption/ーSpeed) 由列表中最近的两个点决定

该列表必须包含 1 到 25 个点, (包含) ,并且不能包含相同速度的重复点。 如果它只包含单个点,则使用该点的消耗率而无需进一步处理。

为最大速度指定的消耗量必须大于或等于倒数第二个最大速度的消耗量。 这可确保外推不会导致负消耗率。

同样,为列表中的两个最小速度指定的消耗值不能导致任何较小速度的负消耗率。

(以 l/100km) 表示的消耗值的有效范围为 0.01 到 100000.0。

合理值:50,6.3:130,11.5

注意 :此参数是 燃烧消耗模型所必需的。

currentChargeInkWh
query

number

double

以千瓦时 (千瓦时) 指定当前电力供应。

此参数与 maxChargeInkWh 参数共存。

允许的值范围为 0.0 到 maxChargeInkWh

合理值:43

currentFuelInLiters
query

number

double

指定燃料的当前供应量(以升为单位)。

合理值:55

decelerationEfficiency
query

number

double

指定当车辆减速 ( (即 ChemicalEnergySaved/KineticEnergyLost) )时,将动能转换为节省 (不消耗) 燃料的效率。ChemicalEnergySaved 是通过使用 fuelEnergyDensityInMJoulesPerLiter 将节省的 (不消耗) 燃料转换为能源来获得的。

必须与 加速效率配对。

允许的值范围为 0.0 到 1/加速效率

合理值:对于 燃烧模型 :0.83,对于 电动模型 :0.91

departAt
query

string

date-time

从源点出发的日期和时间,格式为 dateTimeRFC 3339 第 5.6 节中定义的值,具有可选的时区偏移量。 如果未指定时区偏移量,则将假定为原点的时区偏移量。

  • 默认值:now
  • 其他值: dateTime

示例:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

参数 departAt 不能与 arriveAt结合使用。

distanceBudgetInMeters
query

number

double

以米为单位的距离预算,用于确定可使用驾驶距离行驶的最大范围。 仅当 routeType 为 eco 时,消耗模型才会影响范围。
必须使用 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters) 的预算。

downhillEfficiency
query

number

double

指定当车辆失去高程 ( (例如 ChemicalEnergySaved/PotentialEnergyLost) )时,将潜在能量转换为节省 (未消耗) 燃料的效率。ChemicalEnergySaved 是通过使用 fuelEnergyDensityInMJoulesPerLiter 将节省的 (不消耗) 燃料转换为能源来获得的。

必须与 uphillEfficiency 配对。

允许的值范围为 0.0 到 1/上坡效率

合理值:对于 燃烧模型 :0.51,对于 电动模型 :0.73

energyBudgetInkWh
query

number

double

以千瓦时 (千瓦时) 的电力能源预算,用于确定可使用指定的用电量模型行驶的最大范围。
使用 energyBudgetInkWh 时,必须指定详细的耗电量模型。
必须使用 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters) 的预算。

fuelBudgetInLiters
query

number

double

燃油预算(以升为单位),确定可以使用指定的燃烧消耗模型行驶的最大范围。
使用 fuelBudgetInLiters 时,必须指定详细的燃烧消耗模型。
必须使用 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters) 的预算。

fuelEnergyDensityInMJoulesPerLiter
query

number

double

指定一升燃料中储存的化学能量(兆焦耳 (MJ) )。 它与 *效率 参数结合使用,用于在节省或消耗的能量与燃料之间进行转换。 例如,汽油的能量密度为 34.2 MJ/l,柴油燃料的能量密度为 35.8 MJ/l。

如果设置了任何 *效率 参数,则此参数是必需的。

合理值:34.2

hilliness
query

InclineLevel

惊心动魄的路线的丘陵程度。 此参数只能与 =thrilling 一起使用 routeType

maxChargeInkWh
query

number

double

指定可能存储在车辆电池中的) 的最大电力供应量(以千瓦时 (千瓦时为单位)。

此参数与 currentChargeInkWh 参数共存。

最小值必须大于或等于 currentChargeInkWh

合理值:85

routeType
query

RouteType

请求的路由类型。

timeBudgetInSec
query

number

double

时间预算(以秒为单位),用于确定可使用驾驶时间行驶的最大范围。 仅当 routeType 为 eco 时,消耗模型才会影响范围。
必须使用 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters) 的预算。

traffic
query

boolean

可能的值:

  • true - 在路由期间考虑所有可用的流量信息
  • false - 在路由期间忽略当前流量数据。 请注意,尽管在路由过程中忽略了当前交通数据,但仍会纳入历史交通对有效道路速度的影响。
travelMode
query

TravelMode

所请求路线的行驶模式。 如果未定义,则默认值为“car”。 请注意,请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节,则该节响应的 travelMode 元素将是“其他”。 请注意,旅行模式公共汽车、摩托车、出租车和面包车是 BETA 功能。 并非所有区域都提供完全限制数据。

uphillEfficiency
query

number

double

指定当车辆获得提升 (即 PotentialEnergyGained/ChemicalEnergyConsumed) 时,将存储在燃料中的化学能转换为潜在能量的效率。ChemicalEnergyConsumed 是通过使用 fuelEnergyDensityInMJoulesPerLiter 将消耗的燃料转换为化学能获得的。

必须与 downhillEfficiency 配对。

允许的值范围为 0.0 到 1/downhillEfficiency

合理值:对于 燃烧模型 :0.27,对于 电动模型 :0.74

vehicleAxleWeight
query

integer

车辆每轴的重量(以公斤为单位)。 值为 0 表示不考虑每个轴的重量限制。

vehicleCommercial
query

boolean

车辆是否用于商业目的。 商用车辆可能不允许在某些道路上行驶。

vehicleEngineType
query

VehicleEngineType

车辆的发动机类型。 指定详细消耗模型时,它必须与 vehicleEngineType 的值一致。

vehicleHeight
query

number

double

车辆的高度(以米为单位)。 值为 0 表示不考虑高度限制。

vehicleLength
query

number

double

车辆长度(以米为单位)。 值为 0 表示不考虑长度限制。

vehicleLoadType
query

VehicleLoadType

可归类为危险品并限制在某些道路的货物类型。 可用的 vehicleLoadType 值包括美国 Hazmat 类 1 到 9,以及用于其他国家/地区的泛型分类。 以 USHazmat 开头的值用于美国路由,而 otherHazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数目前仅考虑用于 travelMode=truck。

vehicleMaxSpeed
query

integer

车辆的最高速度(以公里/小时为单位)。 车辆配置文件中的最大速度用于检查是否允许车辆在高速公路上行驶。

  • 值为 0 表示将在路线规划期间确定并应用车辆的适当值。

  • 在路线规划期间,可能会重写非零值。 例如,当前交通流量为 60 公里/小时。 如果车辆最高时速设置为 50 公里/小时,则路由引擎将考虑 60 km/小时,这是目前的情况。 如果车辆的最高时速为 80 公里/小时,但当前交通流量为 60 公里/小时,则路由引擎将再次使用 60 公里/小时。

vehicleWeight
query

integer

车辆的重量(以公斤为单位)。

  • 如果设置了任何效率参数,则是必需的。

  • 在消耗模型的上下文中使用时,它必须严格为正。 考虑重量限制。

  • 如果未指定详细的 消耗模型 ,并且 vehicleWeight 的值非零,则考虑重量限制。

  • 在所有其他情况下,将忽略此参数。

合理值:对于 燃烧模型 :1600,对于 电气模型 :1900

vehicleWidth
query

number

double

车辆宽度(以米为单位)。 值为 0 表示不考虑宽度限制。

windingness
query

WindingnessLevel

惊心动魄的路线的转弯水平。 此参数只能与 =thrilling 一起使用 routeType

请求头

名称 必需 类型 说明
x-ms-client-id

string

指定要与 Microsoft Entra ID 安全模型一起使用的帐户。 它表示 Azure Maps 帐户的唯一 ID,可以从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性,请参阅以下 文章 以获取指导。

响应

名称 类型 说明
200 OK

RouteRangeResult

确定

Other Status Codes

ErrorResponse

发生了意外错误。

安全性

AADToken

这些是 Microsoft Entra OAuth 2.0 流。 与 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 可以基于配置设置多个用例的应用程序。

类型: 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 资源 上的列出 SAS 操作创建的共享访问签名令牌。

使用此令牌,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域 () 。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序,我们建议在 映射帐户资源 上配置允许的来源的特定列表,以限制呈现滥用,并定期续订 SAS 令牌。

类型: apiKey
在: header

示例

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

示例请求

GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000

示例响应

{
  "formatVersion": "0.0.1",
  "reachableRange": {
    "center": {
      "latitude": 50.9745,
      "longitude": 5.86605
    },
    "boundary": [
      {
        "latitude": 52.03704,
        "longitude": 5.73602
      },
      {
        "latitude": 52.09456,
        "longitude": 5.59435
      },
      {
        "latitude": 52.16815,
        "longitude": 5.42279
      },
      {
        "latitude": 52.25047,
        "longitude": 5.21276
      },
      {
        "latitude": 52.21374,
        "longitude": 5.15355
      },
      {
        "latitude": 52.25674,
        "longitude": 4.96687
      },
      {
        "latitude": 52.07834,
        "longitude": 4.739
      },
      {
        "latitude": 52.05647,
        "longitude": 4.72513
      },
      {
        "latitude": 51.94553,
        "longitude": 4.53237
      },
      {
        "latitude": 51.70119,
        "longitude": 4.31165
      },
      {
        "latitude": 51.5837,
        "longitude": 4.28917
      },
      {
        "latitude": 51.48463,
        "longitude": 3.82685
      },
      {
        "latitude": 51.21096,
        "longitude": 3.62838
      },
      {
        "latitude": 50.6814,
        "longitude": 3.89244
      },
      {
        "latitude": 50.66791,
        "longitude": 3.93493
      },
      {
        "latitude": 50.49042,
        "longitude": 3.98156
      },
      {
        "latitude": 50.30944,
        "longitude": 4.47995
      },
      {
        "latitude": 50.24448,
        "longitude": 4.60502
      },
      {
        "latitude": 50.24467,
        "longitude": 4.89999
      },
      {
        "latitude": 50.08735,
        "longitude": 5.04206
      },
      {
        "latitude": 49.99214,
        "longitude": 5.23042
      },
      {
        "latitude": 49.88478,
        "longitude": 5.40994
      },
      {
        "latitude": 49.85797,
        "longitude": 5.46178
      },
      {
        "latitude": 49.86279,
        "longitude": 5.7196
      },
      {
        "latitude": 49.83259,
        "longitude": 5.74151
      },
      {
        "latitude": 50.22239,
        "longitude": 5.9387
      },
      {
        "latitude": 50.0011,
        "longitude": 6.08535
      },
      {
        "latitude": 50.04616,
        "longitude": 6.12089
      },
      {
        "latitude": 50.09472,
        "longitude": 6.28373
      },
      {
        "latitude": 49.95863,
        "longitude": 6.51654
      },
      {
        "latitude": 50.00485,
        "longitude": 6.61034
      },
      {
        "latitude": 50.00587,
        "longitude": 6.70295
      },
      {
        "latitude": 50.2947,
        "longitude": 6.65865
      },
      {
        "latitude": 50.36903,
        "longitude": 6.79276
      },
      {
        "latitude": 50.31614,
        "longitude": 7.32163
      },
      {
        "latitude": 50.36737,
        "longitude": 7.58782
      },
      {
        "latitude": 50.46919,
        "longitude": 7.7626
      },
      {
        "latitude": 50.96246,
        "longitude": 7.9826
      },
      {
        "latitude": 51.07086,
        "longitude": 7.55924
      },
      {
        "latitude": 51.36614,
        "longitude": 7.58138
      },
      {
        "latitude": 51.52015,
        "longitude": 7.67861
      },
      {
        "latitude": 51.65781,
        "longitude": 7.35175
      },
      {
        "latitude": 51.81916,
        "longitude": 7.21664
      },
      {
        "latitude": 51.9587,
        "longitude": 7.0467
      },
      {
        "latitude": 51.82713,
        "longitude": 6.67267
      },
      {
        "latitude": 51.81133,
        "longitude": 6.48424
      },
      {
        "latitude": 51.9368,
        "longitude": 6.27316
      },
      {
        "latitude": 52.01701,
        "longitude": 6.14452
      },
      {
        "latitude": 52.20847,
        "longitude": 6.09312
      },
      {
        "latitude": 52.23705,
        "longitude": 6.01297
      }
    ]
  }
}

定义

名称 说明
EffectiveSetting

调用此路由 API 时使用的有效参数或数据。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

InclineLevel

惊心动魄的路线的丘陵程度。 此参数只能与 =thrilling 一起使用 routeType

LatLongPair

表示为纬度和经度的位置。

ResponseFormat

响应的所需格式。 值可以是 jsonxml

RouteAvoidType

指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定,例如,“&avoid=高速公路&avoid=tollRoads&avoid=ferries”。 在路由范围请求中,不得使用已UsedRoads 值。

RouteRange

可访问范围

RouteRangeResult

此对象是从成功的路由可访问范围调用返回的

RouteReport

报告当前调用中使用的有效设置。

RouteType

请求的路由类型。

TravelMode

所请求路线的行驶模式。 如果未定义,则默认值为“car”。 请注意,请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节,则该节响应的 travelMode 元素将是“其他”。 请注意,旅行模式公共汽车、摩托车、出租车和面包车是 BETA 功能。 并非所有区域都提供完全限制数据。

VehicleEngineType

车辆的发动机类型。 指定详细消耗模型时,它必须与 vehicleEngineType 的值一致。

VehicleLoadType

可归类为危险品并限制在某些道路的货物类型。 可用的 vehicleLoadType 值包括美国 Hazmat 类 1 到 9,以及用于其他国家/地区的泛型分类。 以 USHazmat 开头的值用于美国路由,而 otherHazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数目前仅考虑用于 travelMode=truck。

WindingnessLevel

惊心动魄的路线的转弯水平。 此参数只能与 =thrilling 一起使用 routeType

EffectiveSetting

调用此路由 API 时使用的有效参数或数据。

名称 类型 说明
key

string

所用参数的名称。

value

string

所用参数的值。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

InclineLevel

惊心动魄的路线的丘陵程度。 此参数只能与 =thrilling 一起使用 routeType

名称 类型 说明
high

string

high

low

string

low

normal

string

一般

LatLongPair

表示为纬度和经度的位置。

名称 类型 说明
latitude

number

Latitude 属性

longitude

number

Longitude 属性

ResponseFormat

响应的所需格式。 值可以是 jsonxml

名称 类型 说明
json

string

JavaScript 对象表示法数据交换格式

xml

string

可扩展标记语言

RouteAvoidType

指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定,例如,“&avoid=高速公路&avoid=tollRoads&avoid=ferries”。 在路由范围请求中,不得使用已UsedRoads 值。

名称 类型 说明
alreadyUsedRoads

string

避免多次使用同一条道路。 最有用的与 routeType=惊心动魄。

borderCrossings

string

避免在路线计算中跨越边界。

carpools

string

避免需要使用拼车 (HOV/高占用车辆) 车道的路线。

ferries

string

避免轮渡

motorways

string

避开高速公路

tollRoads

string

避免收费公路。

unpavedRoads

string

避免未铺设的道路

RouteRange

可访问范围

名称 类型 说明
boundary

LatLongPair[]

表示为点列表的可访问范围的多边形边界。

center

LatLongPair

可访问范围的中心点

RouteRangeResult

此对象是从成功的路由可访问范围调用返回的

名称 类型 说明
formatVersion

string

Format Version 属性

reachableRange

RouteRange

可访问范围

report

RouteReport

报告当前调用中使用的有效设置。

RouteReport

报告当前调用中使用的有效设置。

名称 类型 说明
effectiveSettings

EffectiveSetting[]

调用此路由 API 时使用的有效参数或数据。

RouteType

请求的路由类型。

名称 类型 说明
eco

string

一条由经济和速度平衡的路线。

fastest

string

最快的路线。

shortest

string

按距离排序的最短路线。

thrilling

string

包括有趣或具有挑战性的道路,并尽可能少地使用高速公路。 可以选择包括的转弯级别和丘陵程度。 请参阅丘陵性和绕组参数,了解如何设置此值。 计划路线限制为 900 公里,= routeType惊心动魄

TravelMode

所请求路线的行驶模式。 如果未定义,则默认值为“car”。 请注意,请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节,则该节响应的 travelMode 元素将是“其他”。 请注意,旅行模式公共汽车、摩托车、出租车和面包车是 BETA 功能。 并非所有区域都提供完全限制数据。

名称 类型 说明
bus

string

返回的路线针对总线进行了优化,包括使用仅限总线的车道。 BETA 功能。

car

string

返回的路线针对汽车进行了优化。

motorcycle

string

返回的路线针对摩托车进行了优化。 BETA 功能。

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

惊心动魄的路线的转弯水平。 此参数只能与 =thrilling 一起使用 routeType

名称 类型 说明
high

string

high

low

string

low

normal

string

一般