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

Route - Get Route Range

参考

服务:: Maps

API 版本:: 1.0

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

注释

Azure Maps Route v1 服务停用

Azure Maps Route v1 服务现已弃用，将于 3/31/28 停用。为了避免服务中断，需要更新对 Route v1 服务的所有调用，以使用 Route v2025-01-01 服务（3/31/28）。有关详细信息，请参阅迁移 Azure Maps 路线 1.0 API。

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

返回的多边形可用于进一步处理，例如 “在几何图形内搜索” 来搜索提供的时序中的 PO。

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	响应的所需格式。值可以是 json ，也可以是 xml 。
api-version	query	True	string	Azure Maps API 的版本号。
query	query	True	number[]	范围计算应从其开始的坐标。
accelerationEfficiency	query		number (double) minimum: 0 maximum: 1	指定当车辆加速（即 KineticEnergyGained/ChemicalEnergyConsumed）时，将燃料中存储的化学能量转换为动能的效率。ChemicalEnergyConsumed 是通过使用 fuelEnergyDensityInMJoulesPerLiter将消耗的燃料转换为化学能量获得的。必须与减速配对。允许的值为 0.0 到 1/减速效率。合理值：燃烧模型：0.33，电动模型：0.66
auxiliaryPowerInkW	query		number (double)	指定用于维持辅助系统（千瓦）的电力量。它可用于指定由于设备和系统（如 AC 系统、无线电、加热等）的消耗。合理的值：1.7
auxiliaryPowerInLitersPerHour	query		number (double)	指定用于维持车辆辅助系统的燃料量（以升/小时为单位）。它可用于指定由于设备和系统（如 AC 系统、无线电、加热等）的消耗。合理的值：0.2
avoid	query		RouteAvoidType[]	指定路由计算在确定路由时应尝试避免的内容。可以在一个请求中多次指定“&avoid=高速公路，&避免=tollRoads&avoid=ferries”。在路由范围请求中，不能使用已使用值UsedRoads。
constantSpeedConsumptionInkWhPerHundredkm	query		string	指定消耗速度相关组件。以无序的速度/消耗率对列表的形式提供。该列表定义消耗曲线上的点。在列表中找不到速度的消耗率，如下所示：通过线性内插，如果给定的速度位于列表中的两个速度之间如果为线性推断，则假定由列表中最近的两个点确定的常量（列表中选择一个常量（）（按线性推断）该列表必须包含 1 到 25 磅（含），并且不能包含相同速度的重复点。如果它仅包含一个点，则使用该点的消耗率而不进行进一步处理。为最大速度指定的消耗必须大于或等于倒数第二个最大速度的消耗量。这可确保推断不会导致负消耗率。同样，为列表中的两个最小速度指定的消耗值不能导致任何较小的速度的负消耗率。消耗值的有效范围（以 kWh/100km 表示）介于 0.01 和 100000.0 之间。合理的值： 50,8.2：130,21.3 用电模型需要此参数。
constantSpeedConsumptionInLitersPerHundredkm	query		string	指定消耗速度相关组件。以无序分隔的速度列表的形式提供，& 消耗率对。该列表定义消耗曲线上的点。在列表中找不到速度的消耗率，如下所示：通过线性内插，如果给定的速度位于列表中的两个速度之间如果为线性推断，则假定由列表中最近的两个点确定的常量（列表中选择一个常量（）（按线性推断）该列表必须包含 1 到 25 磅（含），并且不能包含相同速度的重复点。如果它仅包含一个点，则使用该点的消耗率而不进行进一步处理。为最大速度指定的消耗必须大于或等于倒数第二个最大速度的消耗量。这可确保推断不会导致负消耗率。同样，为列表中的两个最小速度指定的消耗值不能导致任何较小的速度的负消耗率。消耗值的有效范围（以 l/100 公里表示）介于 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) minimum: 0 maximum: 1	指定当车辆减速（即 ChemicalEnergySaved/KineticEnergyLost）时，将动能转换为节约（未消耗）燃料的效率。ChemicalEnergySaved 是通过使用燃料EnergyDensityInMJoulesPerLiter将节约的（未消耗）燃料转换为能量获得的。必须与 accelerationEfficiency配对。允许的值为 0.0 到 1/accelerationEfficiency。合理的值：对于燃烧模型： 0.83，对于电动模型： 0.91
departAt	query		string (date-time)	`dateTime`（可选时区偏移量）中定义的值的出发日期和时间。如果未指定时区偏移量，则假定其为原点的偏移量。默认值：现在其他值：`dateTime` 例子： 2023-12-19T16：39：57 2023-12-19T16：39：57-08：00 `departAt` 参数不能与 `arriveAt`结合使用。
distanceBudgetInMeters	query		number (double)	距离预算（以米为单位），用于确定可使用驾驶距离行驶的最大范围。消耗模型只会在 routeType 为生态时影响范围。必须使用一个预算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。
downhillEfficiency	query		number (double) minimum: 0 maximum: 1	指定当车辆失去海拔（即 ChemicalEnergySaved/PotentialEnergyLost）时将潜在能量转换为节约（未消耗）燃料的效率。ChemicalEnergySaved 是通过使用燃料EnergyDensityInMJoulesPerLiter将节约的（未消耗）燃料转换为能量获得的。必须与上坡效率配对。允许的值为 0.0 到 1/uphillEfficiency。合理值：燃烧模型：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	惊心动魄的路线的丘陵程度。此参数只能与 `routeType`=thrilling 结合使用。
maxChargeInkWh	query		number (double)	指定可存储在车辆电池中的千瓦时（千瓦时）的最大电力供应量。此参数与 currentChargeInkWh 参数共存。最小值必须大于或等于 currentChargeInkWh。合理的值： 85
routeType	query		RouteType	请求的路由类型。
timeBudgetInSec	query		number (double)	时间预算（以秒为单位），确定可使用驾驶时间行驶的最大范围。消耗模型只会在 routeType 为生态时影响范围。必须使用一个预算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。
traffic	query		boolean	可能的值： true - 在路由期间考虑所有可用的流量信息 false - 在路由期间忽略当前流量数据。请注意，虽然当前交通数据在路由期间被忽略，但历史交通对有效道路速度的影响仍会合并。
travelMode	query		TravelMode	所请求路线的旅行模式。如果未定义，则默认值为“car”。请注意，请求的 travelMode 可能不适用于整个路线。如果请求的 travelMode 不适用于特定节，则响应的 travelMode 元素将为“其他”。请注意，旅行模式巴士、摩托车、出租车和面包车是 BETA 功能。完全限制数据在所有方面都不可用。
uphillEfficiency	query		number (double) minimum: 0 maximum: 1	指定当车辆提升（即 PotentialEnergyGained/ChemicalEnergyConsumed）时，将存储在燃料中的化学能量转换为潜在能量的效率。ChemicalEnergyConsumed 是通过使用 fuelEnergyDensityInMJoulesPerLiter将消耗的燃料转换为化学能量获得的。必须与下坡效率配对。允许的值为 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 开头的值用于美国路由，而其他Hazmat 应用于所有其他国家/地区。可以多次指定 vehicleLoadType。此参数当前仅考虑用于 travelMode=truck。
vehicleMaxSpeed	query		integer	车辆的最大速度（以公里/小时为单位）。车辆配置文件中的最大速度用于检查是否允许车辆在高速公路上。值为 0 表示将在路线规划期间确定并应用车辆的相应值。在路由规划期间，可能会重写非零值。例如，当前流量流为 60 公里/小时。如果车辆最大速度设置为 50 公里/小时，路由引擎将考虑 60 公里/小时，因为这是目前的情况。如果车辆的最大速度为 80 公里/小时，但当前交通流量为 60 公里/小时，则路由引擎将再次使用 60 公里/小时。
vehicleWeight	query		integer	车辆重量（以公斤为单位）。如果设置了任何效率参数，则是必需的。在消耗模型上下文中使用时，它必须严格为正。考虑权重限制。如果未指定详细的消耗模型，并且车辆重量* 的值为非零，则考虑重量限制。在所有其他情况下，将忽略此参数。合理值：燃烧模型：1600，电动模型：1900
vehicleWidth	query		number (double)	车辆宽度（以米为单位）。值为 0 表示不考虑宽度限制。
windingness	query		WindingnessLevel	惊心动魄的路线的转弯水平。此参数只能与 `routeType`=thrilling 结合使用。

请求头

名称	必需	类型	说明
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 允许为多个用例设置基于应用程序的配置。

有关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 资源上的列表 SAS 操作创建。

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

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

类型: apiKey
在: header

示例

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

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "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	惊心动魄的路线的丘陵程度。此参数只能与 `routeType`=thrilling 结合使用。
LatLongPair	表示为纬度和经度的位置。
ResponseFormat	响应的所需格式。值可以是 json ，也可以是 xml 。
RouteAvoidType	指定路由计算在确定路由时应尝试避免的内容。可以在一个请求中多次指定“&avoid=高速公路，&避免=tollRoads&avoid=ferries”。在路由范围请求中，不能使用已使用值UsedRoads。
RouteRange	可访问范围
RouteRangeResult	此对象是从成功的路由可访问范围调用返回的
RouteReport	报告当前调用中使用的有效设置。
RouteType	请求的路由类型。
TravelMode	所请求路线的旅行模式。如果未定义，则默认值为“car”。请注意，请求的 travelMode 可能不适用于整个路线。如果请求的 travelMode 不适用于特定节，则响应的 travelMode 元素将为“其他”。请注意，旅行模式巴士、摩托车、出租车和面包车是 BETA 功能。完全限制数据在所有方面都不可用。
VehicleEngineType	车辆的引擎类型。指定详细消耗模型时，它必须与 vehicleEngineType的值一致。
VehicleLoadType	可能归类为危险物质的货物类型，并受某些道路限制。可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9，以及用于其他国家/地区的通用分类。以 USHazmat 开头的值用于美国路由，而其他Hazmat 应用于所有其他国家/地区。可以多次指定 vehicleLoadType。此参数当前仅考虑用于 travelMode=truck。
WindingnessLevel	惊心动魄的路线的转弯水平。此参数只能与 `routeType`=thrilling 结合使用。

EffectiveSetting

Object

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

名称	类型	说明
key	string	所使用的参数的名称。
value	string	所使用的参数的值。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

InclineLevel

枚举

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

值	说明
high	高
low	低
normal	正常

LatLongPair

Object

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

名称	类型	说明
latitude	number (double)	Latitude 属性
longitude	number (double)	经度属性

ResponseFormat

枚举

响应的所需格式。值可以是 json ，也可以是 xml 。

值	说明
json	JavaScript 对象表示法数据交换格式
xml	可扩展标记语言

RouteAvoidType

枚举

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

值	说明
alreadyUsedRoads	避免多次使用相同的道路。最有用的与 `routeType`=惊心动魄。
borderCrossings	避免在路由计算中跨越边界。
carpools	避免需要使用拼车（HOV/高占用车辆）车道的路线。
ferries	避免渡轮
motorways	避免高速公路
tollRoads	避免收费公路。
unpavedRoads	避免未修补的道路

RouteRange

Object

可访问范围

名称	类型	说明
boundary	LatLongPair[]	可到达范围的多边形边界表示为点列表。
center	LatLongPair	可到达范围的中心点

RouteRangeResult

Object

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

名称	类型	说明
formatVersion	string	Format Version 属性
reachableRange	RouteRange	可访问范围
report	RouteReport	报告当前调用中使用的有效设置。

RouteReport

Object

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

名称	类型	说明
effectiveSettings	EffectiveSetting[]	调用此路由 API 时使用的有效参数或数据。

RouteType

枚举

请求的路由类型。

值	说明
eco	经济和速度平衡的路线。
fastest	最快路线。
shortest	最短的路线（按距离）。
thrilling	包括有趣的或具有挑战性的道路，并尽可能少地使用高速公路。可以选择包括的轮次级别以及丘陵程度。有关如何设置此参数，请参阅丘陵和曲折参数。计划路线限制为 900 公里， `routeType`= 惊心动魄

TravelMode

枚举

所请求路线的旅行模式。如果未定义，则默认值为“car”。请注意，请求的 travelMode 可能不适用于整个路线。如果请求的 travelMode 不适用于特定节，则响应的 travelMode 元素将为“其他”。请注意，旅行模式巴士、摩托车、出租车和面包车是 BETA 功能。完全限制数据在所有方面都不可用。

值	说明
bus	返回的路线针对公共汽车进行了优化，包括仅使用公交车道。 BETA 功能。
car	返回的路线针对汽车进行了优化。
motorcycle	返回的路线针对摩托车进行了优化。 BETA 功能。
taxi	返回的路线针对出租车进行了优化。 BETA 功能。
truck	返回的路线针对商用车辆进行了优化，例如卡车。
van	返回的路线针对面包车进行了优化。 BETA 功能。

VehicleEngineType

枚举

车辆的引擎类型。指定详细消耗模型时，它必须与 vehicleEngineType的值一致。

值	说明
combustion	内燃机。
electric	电动发动机。

VehicleLoadType

枚举

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

值	说明
USHazmatClass1	炸药
USHazmatClass2	压缩气体
USHazmatClass3	易燃液体
USHazmatClass4	易燃固体
USHazmatClass5	Oxidizers
USHazmatClass6	毒药
USHazmatClass7	放射性
USHazmatClass8	腐蚀
USHazmatClass9	杂项
otherHazmatExplosive	炸药
otherHazmatGeneral	杂项
otherHazmatHarmfulToWater	有害于水

WindingnessLevel

枚举

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

值	说明
high	高
low	低
normal	正常