Route - Post Route Directions Batch

用于在单个异步请求中向 获取路由方向 API 发送一批查询。

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

提交异步批处理请求

异步 API 适用于处理大量相对复杂的路由请求

• 它允许在单独的调用中检索结果（可能有多个下载）。
• 异步 API 针对可靠性进行优化，预计不会遇到超时。
• 此 API 的批项数限制为 700。

使用异步请求发出请求时，默认情况下，服务会返回响应标头的“位置”字段中的重定向 URL 的 202 响应代码。 应定期检查此 URL，直到响应数据或错误信息可用。 异步响应的存储时间为 24 小时 。 重定向 URL 返回 404 响应（如果在到期期限后使用）。

请注意，异步批处理请求是长时间运行的操作。 下面是一系列典型的操作：

1. 客户端向 Azure Maps 发送路由方向批处理 POST 请求。

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

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

   HTTP 202 Accepted - 已接受 Batch 请求。

   HTTP Error - 处理 Batch 请求时出错。 这可能是 400 Bad Request 或任何其他 Error 状态代码。

3. 如果成功接受批处理请求，则响应中的 Location 标头包含用于下载批处理请求结果的 URL。 此状态 URI 如下所示：

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

4. 客户端在 下载 URL 步骤 3 中发出 GET 请求来下载批处理结果。

批处理请求的 POST 正文

若要发送 路由方向 查询，将使用 POST 请求，其中请求正文将包含 json 格式的 batchItems 数组，Content-Type 标头将设置为 application/json。 下面是一个示例请求正文，其中包含 3 个 路由方向 查询：

{
    "batchItems": [
        { "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" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

批处理中 查询 路由方向只是部分 URL ，无需 协议、基 URL、路径、api 版本和订阅密钥。 它可以接受任何受支持的 路由方向URI 参数。 路由方向中的字符串值 查询必须正确转义（例如“字符应使用 \ 进行转义），并且还应正确编码 URL。

异步 API 允许调用方对多达 700 个 查询进行批处理，并同步 API 最多 100 个 查询，批处理应至少包含 1 个 查询。

下载异步批处理结果

若要下载异步批处理结果，将向批处理下载终结点发出 GET 请求。 可以从成功 POST 批处理请求的 Location 标头获取此 下载 URL，如下所示：

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

下面是用于下载批处理结果的典型操作序列：

1. 客户端使用 下载 URL发送 GET 请求。

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

   HTTP 202 Accepted - 已接受 Batch 请求，但仍正在处理。 请在一段时间后重试。

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

批处理响应模型

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

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

• Error - 如果查询失败。 在这种情况下，响应将包含 code 和 message。

下面是一个示例 Batch 响应，其中 1 个 成功,1 个 失败 结果：

{
    "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/json?api-version=1.0

URI 参数

请求头

请求正文

响应

安全性

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

作用域

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 submit a route direction batch request

POST https://atlas.microsoft.com/route/directions/batch/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"
    }
  ]
}

{
  "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
  }
}

operation-Location: URL to download the results of the long-running batch request.

定义

BatchRequest

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

BatchRequestItem

Batch 请求对象

DelayMagnitude

事件造成的延迟幅度。 这些值对应于 获取交通事件详细信息 API的响应字段 ty 的值。

DrivingSide

指示在机动点的左侧与右侧驾驶。

EffectiveSetting

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

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

GuidanceInstructionType

指令的类型，例如道路窗体的转弯或更改。

GuidanceManeuver

标识操纵的代码。

JsonFormat

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

JunctionType

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

LatLongPair

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

Response

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

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

ResponseSectionType

报告的路由响应的节类型

ResponseTravelMode

计算路线的旅行模式。 如果在本节中无法实现请求的传输模式，该值将设置为 other

Route

RouteDirectionsBatchItem

从路由方向批处理服务调用返回的项。

RouteDirectionsBatchResult

此对象是从成功的路由方向批处理服务调用返回的。

RouteGuidance

包含与指南相关的元素。 仅当请求指导且可用时，才会显示此字段。

RouteInstruction

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

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.

RouteInstructionGroup

对相互相关的指令元素序列进行分组。 序列范围受 firstInstructionIndex 和 lastInstructionIndex 约束。 当请求人工可读的短信以获取指导（instructionType=text 或标记），则 instructionGroup 将返回一条摘要消息（如果可用）。

RouteLeg

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

RouteLegSummary

路由节的摘要对象。

RouteOptimizedWaypoint

优化的方式点对象。

RouteReport

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

RouteSection

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

RouteSectionTec

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

RouteSectionTecCause

流量事件的原因。 可以包含 mainCauseCode 和 subCauseCode 元素。 可用于定义图标和说明。

RouteSummary

Summary 对象

SimpleCategory

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

Summary

批处理请求结果摘要