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

Route - Post Route Directions Batch Sync

服务:

Maps

API 版本:

1.0

使用 在单个同步请求中将一批查询发送到 获取路由方向 API。

Post Route Directions Batch Sync API 是一个 HTTP POST 请求，它使用单个同步请求将成批的查询发送到获取路由方向 API。 可以调用 Route Directions Batch API 以异步 (异步运行异步) 或同步 (同步) 。 异步 API 允许调用方批处理最多 700 个查询，并同步 API 最多 100 个查询。 若要在异步请求中调用 Post Route Directions Batch API，请参阅 发布路由方向批处理。

提交同步批处理请求

建议将同步 API 用于轻型批处理请求。 当服务收到请求时，它会在计算批处理项后立即响应，并且以后无法检索结果。 如果请求花费的时间超过 60 秒，同步 API 将 (408 响应) 返回超时错误。 此 API 的批处理项数限制为 100 。

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

批处理响应模型

对于异步和同步请求，返回的数据内容类似。 下载异步批处理请求的结果时，如果批处理已完成处理，则响应正文将包含批处理响应。 此批处理响应包含一个 summary 组件，该 totalRequests 组件指示是原始批处理请求的一部分， successfulRequests即已成功执行的查询。 批处理响应还包括一个 batchItems 数组，其中包含批处理请求中每个查询的响应。 将 batchItems 包含结果，其顺序与原始查询在批处理请求中的发送顺序完全相同。 中的每个 batchItems 项都包含 statusCode 和 response 字段。 中的每个 response 类型 batchItems 为以下类型之一：

• RouteDirections - 如果查询成功完成。

• Error - 如果查询失败。 在本例中，响应将包含 code 和 message 。

下面是包含 1 个 成功 和 1 个 失败 结果的示例 Batch 响应：

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

URI 参数

名称	在	必需	类型	说明
format	path	True	JsonFormat	响应的所需格式。 仅支持 json 格式。
api-version	query	True	string	Azure Maps API 的版本号。

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定用于与 Microsoft Entra ID 安全模型结合使用的帐户。 它表示 Azure Maps 帐户的唯一 ID，可从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性，请参阅以下 文章 以获取指导。

请求正文

名称	类型	说明
batchItems	BatchRequestItem[]	要处理的查询的列表。

响应

名称	类型	说明
200 OK	RouteDirectionsBatchResult	确定
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 可以针对多个用例对应用程序进行基于配置的设置。

• 有关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 the route direction batch result synchronously

示例请求

HTTP

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
    },
    {
      "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
    }
  ]
}

示例响应

状态代码:

200

{
  "batchItems": [
    {
      "statusCode": 400,
      "response": {
        "error": {
          "code": "400 BadRequest",
          "message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
        }
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1754,
              "travelTimeInSeconds": 386,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:02:49+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1754,
                  "travelTimeInSeconds": 386,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:02:49+00:00"
                },
                "points": [
                  {
                    "latitude": 47.62094,
                    "longitude": -122.34892
                  },
                  {
                    "latitude": 47.62094,
                    "longitude": -122.3485
                  },
                  {
                    "latitude": 47.62095,
                    "longitude": -122.3476
                  },
                  {
                    "latitude": 47.60995,
                    "longitude": -122.34174
                  },
                  {
                    "latitude": 47.61011,
                    "longitude": -122.342
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 44,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "bicycle"
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1772,
              "travelTimeInSeconds": 1276,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:17:38+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1772,
                  "travelTimeInSeconds": 1276,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:17:38+00:00"
                },
                "points": [
                  {
                    "latitude": 40.75982,
                    "longitude": -73.98493
                  },
                  {
                    "latitude": 40.7601,
                    "longitude": -73.98483
                  },
                  {
                    "latitude": 40.75984,
                    "longitude": -73.98417
                  },
                  {
                    "latitude": 40.76047,
                    "longitude": -73.9837
                  },
                  {
                    "latitude": 40.77095,
                    "longitude": -73.9736
                  },
                  {
                    "latitude": 40.77114,
                    "longitude": -73.97356
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 47,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "pedestrian"
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 3
  }
}

状态代码:

408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

定义

名称	说明
BatchRequest	此类型表示 Batch 服务的请求正文。
BatchRequestItem	Batch 请求对象
DelayMagnitude	事件导致的延迟程度。 这些值对应于 获取交通事件详细信息 API 的响应字段 ty 的值。
DrivingSide	指示在机动点的左侧和右侧驾驶。
EffectiveSetting	调用此路由 API 时使用的有效参数或数据。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GuidanceInstructionType	指令的类型，例如，转弯或更改道路形式。
GuidanceManeuver	标识操作的代码。
JsonFormat	响应的所需格式。 仅支持 json 格式。
JunctionType	进行机动的交汇点的类型。 对于较大的环形交叉路口，将生成两个单独的指令，用于进入和离开环形交叉路口。
LatLongPair	表示为纬度和经度的位置。
Response	查询结果。 如果查询成功完成，则为 RouteDirections;否则为 ErrorResponse。
ResponseSectionType	报告的路由响应的节类型
ResponseTravelMode	计算路线的行驶模式。 如果在本部分中无法实现请求的传输模式，则该值将设置为other
Route
RouteDirectionsBatchItem	从路线路线批处理服务调用返回的项。
RouteDirectionsBatchResult	此对象是从成功的 Route Directions Batch 服务调用返回的。
RouteGuidance	包含指南相关元素。 仅当请求了指导并可用时，此字段才存在。
RouteInstruction	描述机动的一组属性，例如“向右转”、“左转”、“乘坐渡轮”、“乘坐高速公路”、“到达”。
RouteInstructionGroup	对彼此相关的指令元素序列进行分组。 序列范围受 firstInstructionIndex 和 lastInstructionIndex 约束。 当请求用户可读文本消息 (instructionType=text 或标记) 指导时，instructionGroup 将返回摘要消息（如果可用）。
RouteLeg	路线的一部分的说明，由点列表组成。 请求中提供的每个附加航点将导致返回的路线中增加一条航段。
RouteLegSummary	route 节的摘要对象。
RouteOptimizedWaypoint	优化路点对象。
RouteReport	报告当前调用中使用的有效设置。
RouteSection	路由部分包含有关路由部分的其他信息。 每个部分至少包含元素 startPointIndex、 endPointIndex和 sectionType。
RouteSectionTec	流量事件的详细信息，使用 TPEG2-TEC 标准中的定义。 可以包含 effectCode 并导致元素。
RouteSectionTecCause	流量事件的原因。 可以包含 mainCauseCode 和 subCauseCode 元素。 可用于定义图标和说明。
RouteSummary	Summary 对象
SimpleCategory	事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或 OTHER。 有关详细信息，请参阅“tec”。
Summary	批处理请求的结果摘要

BatchRequest

此类型表示 Batch 服务的请求正文。

名称	类型	说明
batchItems	BatchRequestItem[]	要处理的查询的列表。

BatchRequestItem

Batch 请求对象

名称	类型	说明
query	string	此参数包含用于执行非结构化地理编码操作的查询字符串。 查询字符串将逐字传递给搜索 API 进行处理。

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	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

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

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	你已到达航点。 它位于右侧。

JsonFormat

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

名称	类型	说明
json	string	JavaScript 对象表示法数据交换格式

JunctionType

进行机动的交汇点的类型。 对于较大的环形交叉路口，将生成两个单独的指令，用于进入和离开环形交叉路口。

名称	类型	说明
BIFURCATION	string	分 岔
REGULAR	string	普通
ROUNDABOUT	string	环形交叉

LatLongPair

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

名称	类型	说明
latitude	number	Latitude 属性
longitude	number	Longitude 属性

Response

查询结果。 如果查询成功完成，则为 RouteDirections;否则为 ErrorResponse。

名称	类型	说明
error	ErrorDetail	错误对象。
formatVersion	string	Format Version 属性
optimizedWaypoints	RouteOptimizedWaypoint[]	优化了航点序列。 它显示用户为原始列表和优化列表提供的航点序列中的索引。 例如，响应： <optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints> 表示原始序列为 [0， 1， 2] ，优化序列为 [1， 2， 0]。 由于索引以 0 开头，因此原始索引为“first， second， third”，而 optimized 为“second， third， first”。
report	RouteReport	报告当前调用中使用的有效设置。
routes	Route[]	路由数组

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	与请求参数 travelMode相关的部分。
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	RouteGuidance	包含指南相关元素。 仅当请求了指导并可用时，此字段才存在。
legs	RouteLeg[]	腿数组
sections	RouteSection[]	Sections 数组
summary	RouteSummary	Summary 对象

RouteDirectionsBatchItem

从路线路线批处理服务调用返回的项。

名称	类型	说明
response	Response	查询结果。 如果查询成功完成，则为 RouteDirections;否则为 ErrorResponse。
statusCode	integer	HTTP 请求状态代码。

RouteDirectionsBatchResult

此对象是从成功的 Route Directions Batch 服务调用返回的。

名称	类型	说明
batchItems	RouteDirectionsBatchItem[]	包含批处理结果的数组。
summary	Summary	批处理请求的结果摘要

RouteGuidance

包含指南相关元素。 仅当请求了指导并可用时，此字段才存在。

名称	类型	说明
instructionGroups	RouteInstructionGroup[]	对彼此相关的指令元素序列进行分组。
instructions	RouteInstruction[]	描述操作的说明列表。

RouteInstruction

描述机动的一组属性，例如“向右转”、“左转”、“乘坐渡轮”、“乘坐高速公路”、“到达”。

名称	类型	说明
combinedMessage	string	与下一条指令中的消息组合在一起的操纵操作的人类可读消息。 有时，可以将两个连续的指令组合成一个指令，使其更易于遵循。 在这种情况下，possibleCombineWithNext 标志将为 true。 例如： 10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam 指令 10 上的 possibleCombineWithNext 标志为 true。 这向编码指南的客户端表明，它可以与指令 11 结合使用。 对于请求人工可读指导的客户端，这些说明将自动合并。 combinedMessage 字段包含合并的消息： Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode	string	3 个字符 的 ISO 3166-1 alpha-3 国家/地区代码。 例如美国。
drivingSide	DrivingSide	指示在操纵点的左侧驾驶与右侧驾驶。
exitNumber	string	当前机动 (高速公路出口的) 数。 如果退出有多个退出编号，则它们将用 “、”分隔，并可能用“-”聚合，例如“10,13-15”。
instructionType	GuidanceInstructionType	指令的类型，例如转弯或更改道路形式。
junctionType	JunctionType	进行操纵的交汇点的类型。 对于较大的环形交叉路口，将生成两个单独的指令，用于进入和离开环形交叉路口。
maneuver	GuidanceManeuver	标识操纵的代码。
message	string	操作的人类可读消息。
point	LatLongPair	表示为纬度和经度的位置。
pointIndex	integer	与指令点对应的折线“点”列表中的点的索引。
possibleCombineWithNext	boolean	可以选择将指令与下一个指令组合在一起。 这可用于生成消息，如“左转，然后向右转”。
roadNumbers	string[]	下一个重要路段 () ) () 后，或要跟踪) (道路的路数。 示例：[“E34”， “N205”]
roundaboutExitNumber	integer	这指示在环形交叉路口要采取哪个出口。
routeOffsetInMeters	integer	从路线起点到指令点的距离。
signpostText	string	路标上的文本，与操纵或应遵循的方向最相关。
stateCode	string	细分 (例如国家/地区的州) ，由 ISO 3166-2 代码的第二部分表示。 这仅适用于某些国家/地区，如美国、加拿大和墨西哥。
street	string	操纵后的下一个重要路段的街道名称，或应遵循的街道的街道名称。
travelTimeInSeconds	integer	估计的行程时间，到与 routeOffsetInMeters 相对应的点。
turnAngleInDecimalDegrees	integer	指示指令的方向。 如果 junctionType 指示轮次指令： 180 = U 型轮次 [-179， -1] = 左转 0 = 直 (“0度”转弯) [1， 179] = 右转 如果 junctionType 指示分叉指令： <0 - 保留左侧 >0 - 保留右侧

RouteInstructionGroup

对彼此相关的指令元素序列进行分组。 序列范围受 firstInstructionIndex 和 lastInstructionIndex 约束。 当请求用户可读文本消息 (instructionType=text 或标记) 指导时，instructionGroup 将返回摘要消息（如果可用）。

名称	类型	说明
firstInstructionIndex	integer	指令中属于此组的第一个指令的索引。
groupLengthInMeters	integer	组的长度。
groupMessage	string	请求人类可读文本消息以获取指导时 (instructionType=text 或标记) 的摘要消息。
lastInstructionIndex	integer	指令中属于此组的最后一条指令的索引。

RouteLeg

路线的一部分的说明，由点列表组成。 请求中提供的每个附加航点将导致返回的路线中增加一条航段。

名称	类型	说明
points	LatLongPair[]	Points 数组
summary	RouteLegSummary	route 节的摘要对象。

RouteLegSummary

route 节的摘要对象。

名称	类型	说明
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	EffectiveSetting[]	调用此路由 API 时使用的有效参数或数据。

RouteSection

路由部分包含有关路由部分的其他信息。 每个部分至少包含元素 startPointIndex、 endPointIndex和 sectionType。

名称	类型	说明
delayInSeconds	integer	事件导致的延迟（以秒为单位）。
effectiveSpeedInKmh	integer	事件的有效速度（以公里/小时为单位），其整个长度的平均值。
endPointIndex	integer	本部分适用的路线中最后一个点的索引 (偏移量为 0) 。
magnitudeOfDelay	DelayMagnitude	事件造成的延迟程度。 这些值对应于 获取交通事件详细信息 API 的响应字段 ty 的值。
sectionType	ResponseSectionType	报告的路由响应的节类型
simpleCategory	SimpleCategory	事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或 OTHER。 有关详细信息，请参阅“tec”。
startPointIndex	integer	本部分适用的路线中第一个点的索引 (偏移量为 0) 。
tec	RouteSectionTec	流量事件的详细信息，使用 TPEG2-TEC 标准中的定义。 可以包含 effectCode 并导致 元素。
travelMode	ResponseTravelMode	计算路线的出行模式。 如果本部分中无法实现请求的传输模式，则该值将设置为other

RouteSectionTec

流量事件的详细信息，使用 TPEG2-TEC 标准中的定义。 可以包含 effectCode 并导致元素。

名称	类型	说明
causes	RouteSectionTecCause[]	导致数组
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 仍包含由于流量导致的延迟。 如果将来的 DepartAt 为 ，则使用与时间相关的历史交通数据计算行程时间。

SimpleCategory

事件的类型。 当前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或 OTHER。 有关详细信息，请参阅“tec”。

名称	类型	说明
JAM	string	塞车。
OTHER	string	其他。
ROAD_CLOSURE	string	道路封闭。
ROAD_WORK	string	道路工作。

Summary

批处理请求的结果摘要

名称	类型	说明
successfulRequests	integer	批处理中成功的请求数
totalRequests	integer	批处理中的请求总数