你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
RouteGetRouteDirectionsBatch202Response interface
Get Route Directions Batch
API 是一个 HTTP GET
请求,它使用单个请求将查询批处理发送到 获取路由方向 API。 可以调用 Get Route Directions Batch
API 以异步(异步)或同步(同步)运行。 异步 API 允许调用方对多达 700 个 查询进行批处理,并将 API 同步到 100 个 查询。
下载异步批处理结果
若要下载异步批处理结果,将向批处理下载终结点发出 GET
请求。 可以从成功 POST
批处理请求的 Location
标头获取此 下载 URL,如下所示:
https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
下面是用于下载批处理结果的典型操作序列:
客户端使用 下载 URL发送
GET
请求。服务器将使用以下项之一进行响应:
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."
}
}
}
]
}
- 扩展
属性
headers | |
status |
继承属性
body | 分析的正文 |
request | 生成此响应的请求。 |
属性详细信息
headers
headers: RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers
属性值
status
status: "202"
属性值
"202"
继承属性详细信息
body
分析的正文
body: unknown
属性值
unknown
继承自 HttpResponse.body