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

Route - Post Route Matrix Sync

使用 获取路线矩阵,使用同步请求显示出发地和目的地列表中所有可能对的行程时间和距离。

Post Route Matrix Sync API 是一个 HTTP POST 请求,它允许使用单个同步 (同步) 请求计算由源位置和目标位置定义的一组路由的路由摘要矩阵。 若要发出异步 (异步) 请求,请参阅 后路由矩阵。 对于每个给定的源,服务都会计算从该源到每个给定目标的路由成本。 可以将原点集和目标集视为表的列标题和行标题,表中的每个单元格都包含从该单元格的源路由到目标的成本。 例如,假设一家食品配送公司有 20 名司机,他们需要找到最近的司机从餐厅取货。 若要解决此用例,他们可以调用矩阵路由 API。

对于每个路线,返回行程时间和距离。 可以使用计算成本来确定使用路线方向 API 计算哪些详细路由。

异步请求的矩阵的最大大小为 700 ,同步请求的最大大小为 100 , (源数乘以目标数) 。

提交同步路由矩阵请求

如果方案需要同步请求,并且矩阵的最大大小小于或等于 100,则可能需要发出同步请求。 此 API 矩阵的最大大小为 100 (源数乘以) 目标数。 考虑到这一约束,可能的矩阵尺寸的示例包括:10x10、6x8、9x8 (它不需要是方形) 。

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

提交异步路由矩阵请求

异步 API 适用于处理大量相对复杂的路由请求。 使用异步请求发出请求时,默认情况下,服务在响应标头的“位置”字段中返回一个重定向 URL 的 202 响应代码。 应定期检查此 URL,直到响应数据或错误信息可用。 如果 waitForResults 请求中的参数设置为 true,则如果在 120 秒内完成请求,用户将收到 200 响应。

此 API 矩阵的最大大小为 700 (源数乘以) 的目标数。 考虑到这一约束,可能的矩阵维度的示例包括:50x10、10x10、28x25。 10x70 (它不需要是正方形) 。

异步响应将存储 14 天。 如果过期后使用重定向 URL,则返回 404 响应。

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

下面是典型的异步操作序列:

  1. 客户端将路线矩阵 POST 请求发送到 Azure Maps

  2. 服务器将使用以下项之一进行响应:

    HTTP 202 Accepted - 已接受路由矩阵请求。

    HTTP Error - 处理路由矩阵请求时出错。 这可能是 400 错误请求或任何其他错误状态代码。

  3. 如果已成功接受矩阵路由请求,则响应中的 Location 标头包含用于下载请求结果的 URL。 此状态 URI 如下所示:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. 客户端在步骤 3 中获取的下载 URL 上发出 GET 请求,以下载结果

下载同步结果

当你对路由矩阵同步 API 发出 POST 请求时,服务将返回 200 个成功请求的响应代码和一个响应数组。 响应正文将包含数据,以后无法检索结果。

下载异步结果

当请求发出响应时 202 Accepted ,将使用异步管道处理该请求。 系统会提供一个 URL,用于在响应的位置标头中检查异步请求的进度。 此状态 URI 如下所示:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

发出请求时 GET ,位置标头提供的 URL 将返回以下响应。

HTTP 202 Accepted - 矩阵请求已接受,但仍在处理中。 请稍后重试。

HTTP 200 OK - 矩阵请求已成功处理。 响应正文包含所有结果。

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0
POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

URI 参数

名称 必需 类型 说明
format
path True

JsonFormat

响应的所需格式。 仅支持 json 格式。

api-version
query True

string

Azure Maps API 的版本号。

arriveAt
query

string

date-time

到达目标点的日期和时间,格式为 dateTimeRFC 3339 第 5.6 节中定义的值,具有可选的时区偏移量。 如果未指定时区偏移量,则将它假定为目标点的时区偏移量。

示例:

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

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

avoid
query

RouteAvoidType[]

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

computeTravelTimeFor
query

ComputeTravelTime

指定是否使用不同类型的交通信息返回其他行程时间, (无、历史、实时) 以及默认的最佳估计行程时间。

departAt
query

string

date-time

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

  • 默认值:立即
  • 其他值: dateTime

示例:

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

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

hilliness
query

InclineLevel

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

routeType
query

RouteType

请求的路由类型。

sectionType
query

SectionType

指定在路由响应中报告哪些节类型。

例如,如果 sectionType = 行人,则返回仅适用于行人的部分。 可以使用多个类型。 default sectionType 引用 travelMode 输入。 默认情况下,travelMode 设置为 car

traffic
query

boolean

可能的值:

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

TravelMode

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

vehicleAxleWeight
query

integer

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

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 公里/小时,这是目前的情况。 如果车辆的最高时速为 80 公里/小时,但当前交通流量为 60 公里/小时,则路由引擎将再次使用 60 公里/小时。

vehicleWeight
query

integer

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

vehicleWidth
query

number

double

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

waitForResults
query

boolean

指示是否同步执行请求的布尔值。 如果设置为 true,则如果在 120 秒内完成请求,用户将收到 200 响应。 否则,用户将立即获得 202 响应。 有关 202 响应的更多详细信息,请参阅 API 说明。 仅支持异步请求

windingness
query

WindingnessLevel

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

请求头

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

string

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

请求正文

名称 类型 说明
destinations

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息,请参阅 RFC 7946

origins

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息,请参阅 RFC 7946

响应

名称 类型 说明
200 OK

RouteMatrixResult

已成功处理矩阵请求。 响应正文包含所有结果。

Other Status Codes

ErrorResponse

超时:请求完成时间长于 API 中定义的最长时间。

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 route matrix request result synchronously

示例请求

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

示例响应

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}
{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

定义

名称 说明
ComputeTravelTime

指定是否使用不同类型的交通信息返回其他行程时间, (无、历史、实时) 以及默认的最佳估计行程时间。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息,请参阅 RFC 7946

InclineLevel

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

JsonFormat

响应的所需格式。 仅支持 json 格式。

RouteAvoidType

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

RouteLegSummary

路由节的摘要对象。

RouteMatrix

矩阵结果对象

RouteMatrixQuery

具有坐标矩阵的 对象。

RouteMatrixResult

此对象是从成功的 Route Matrix 调用返回的。 例如,如果提供了 2 个源和 3 个目标,则每个数组将包含 3 个元素的数组。 每个元素的内容取决于查询中提供的选项。

RouteMatrixResultResponse

输入矩阵中当前单元格的响应对象。

RouteMatrixSummary

Summary 对象

RouteType

请求的路由类型。

SectionType

指定在路由响应中报告哪些节类型。

例如,如果 sectionType = 行人,则返回仅适用于行人的部分。 可以使用多个类型。 default sectionType 引用 travelMode 输入。 默认情况下,travelMode 设置为 car

TravelMode

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

VehicleLoadType

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

WindingnessLevel

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

ComputeTravelTime

指定是否使用不同类型的交通信息返回其他行程时间, (无、历史、实时) 以及默认的最佳估计行程时间。

名称 类型 说明
all

string

计算所有类型的交通信息的行程时间,并指定路由响应中汇总中包含的字段 noTrafficTravelTimeInSeconds、historicTrafficTravelTimeInSeconds 和 liveTrafficIncidentsTravelTimeInSeconds 中的所有结果。

none

string

不计算额外的行程时间。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
coordinates

number[]

几何图形的 GeoJson MultiPoint 坐标。

type string:

MultiPoint

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

InclineLevel

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

名称 类型 说明
high

string

high

low

string

low

normal

string

一般

JsonFormat

响应的所需格式。 仅支持 json 格式。

名称 类型 说明
json

string

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

RouteAvoidType

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

名称 类型 说明
alreadyUsedRoads

string

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

borderCrossings

string

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

carpools

string

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

ferries

string

避免渡轮

motorways

string

避开高速公路

tollRoads

string

避免收费公路。

unpavedRoads

string

避免未铺设的道路

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,则使用与时间相关的历史交通数据计算旅行时间。

RouteMatrix

矩阵结果对象

名称 类型 说明
response

RouteMatrixResultResponse

输入矩阵中当前单元格的响应对象。

statusCode

integer

输入矩阵中当前单元格的 StatusCode 属性。

RouteMatrixQuery

具有坐标矩阵的 对象。

名称 类型 说明
destinations

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息,请参阅 RFC 7946

origins

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息,请参阅 RFC 7946

RouteMatrixResult

此对象是从成功的 Route Matrix 调用返回的。 例如,如果提供了 2 个源和 3 个目标,则每个数组将包含 3 个元素的数组。 每个元素的内容取决于查询中提供的选项。

名称 类型 说明
formatVersion

string

Format Version 属性

matrix

RouteMatrix[]

结果为路由摘要的 2 维数组。

summary

RouteMatrixSummary

Summary 对象

RouteMatrixResultResponse

输入矩阵中当前单元格的响应对象。

名称 类型 说明
routeSummary

RouteLegSummary

路由节的摘要对象。

RouteMatrixSummary

Summary 对象

名称 类型 说明
successfulRoutes

integer

响应中成功的路由数。

totalRoutes

integer

请求的路由总数。 输入矩阵中的单元格数。

RouteType

请求的路由类型。

名称 类型 说明
eco

string

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

fastest

string

最快的路线。

shortest

string

按距离排序的最短路线。

thrilling

string

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

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

与请求参数 travelMode相关的部分。

tunnel

string

属于隧道的路线部分。

urban

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 功能。

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

一般